Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Fix formatting
  • Loading branch information
ruairi-hayes authored Feb 1, 2024
1 parent bd8817d commit bfe32ab
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,9 @@ The following parameters are always required:
- API_FOLDERS - One or more folder names containing APIs to sync with apiconnect discovery repo separated by comma. <br /> &nbsp; Example : `APIFiles,APIFolders`
- resync_check: Indicates if changes to the action like at initial creation should trigger a api-file sync.
- git_diff: (Optional) Git diff between the current and the previous commit. If multiple files have changed in the commit then the workflow will run only if one of the files supplied in `API_FILES` or `API_FOLDERS` has changed.
- apikey - An API Key can be obtained from the api-manager for the user who has access to post the API.<br />
&nbsp An API key can be created by logging into the APIC Manager UI and selecting the "My API Keys" option under the profile icon from the top navigation bar. It is good practice to store any sensitive data like the apikey as a github action secret. See [here](https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository) for more details. For the sample below the github secret should be called `apicApikey` as it will need to match the following templated value ${{ secrets.apicApikey }}
- apikey - An API Key can be obtained from the api-manager for the user who has access to post the API.<br />
An API key can be created by logging into the APIC Manager UI and selecting the "My API Keys" option under the profile icon from the top navigation bar. It is good practice to store any sensitive data like the apikey as a github action secret. See [here](https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository) for more details. For the sample below the github secret should be called `apicApikey` as it will need to match the following templated value
${{ secrets.apicApikey }}

The format of the API documents can be json or yaml. Among the parameters used, either `API_FILES` or `API_FOLDERS` needs to be supplied according to how the API documents are sent. The APIs can be sent to the API connect discovery service in any one of the following ways - single/multiple documents or folder/folders with APIs documents in it. Single and multiple documents will be supplied through `API_FILES` param and single and multiple folders with many API files inside will be supplied through `API_FOLDERS` param.<br />
To send the documents, create the workflow in your GitHub repository similar to one of the samples below
Expand Down

0 comments on commit bfe32ab

Please sign in to comment.