-
Notifications
You must be signed in to change notification settings - Fork 227
DOCS-1206 - Another attempt to add API docs #5949
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| --- | ||
| id: parsers-library-management | ||
| title: Parsers Library Management APIs | ||
| sidebar_label: Parsers Library | ||
| description: Customize parsers using the API. | ||
| --- | ||
|
|
||
| import useBaseUrl from '@docusaurus/useBaseUrl'; | ||
| import ApiIntro from '../reuse/api-intro.md'; | ||
| import ApiRoles from '../reuse/api-roles.md'; | ||
|
|
||
| <img src={useBaseUrl('img/icons/operations/parsing-data.png')} alt="Thumbnail icon" width="50"/> | ||
|
|
||
| Use this API to customize parsers. The parsers library contains the parsers used in the `_parser` field for collector, FER, or query. For more information on customizing parsers, see [Parser Editor](/docs/cse/schema/parser-editor/). | ||
|
|
||
| ## Documentation | ||
|
|
||
| <ApiIntro/> | ||
|
|
||
| | Deployment | Documentation URL | | ||
| |:------------|:-------------------------------------------------------------| | ||
| | AU | https://api.au.sumologic.com/docs/#tag/parsersLibraryManagement | | ||
| | CA | https://api.ca.sumologic.com/docs/#tag/parsersLibraryManagement | | ||
| | DE | https://api.de.sumologic.com/docs/#tag/parsersLibraryManagement | | ||
| | EU | https://api.eu.sumologic.com/docs/#tag/parsersLibraryManagement | | ||
| | FED | https://api.fed.sumologic.com/docs/#tag/parsersLibraryManagement | | ||
| | JP | https://api.jp.sumologic.com/docs/#tag/parsersLibraryManagement | | ||
| | KR | https://api.kr.sumologic.com/docs/#tag/parsersLibraryManagement | | ||
| | US1 | https://api.sumologic.com/docs/#tag/parsersLibraryManagement | | ||
| | US2 | https://api.us2.sumologic.com/docs/#tag/parsersLibraryManagement | | ||
|
|
||
| ## Required role capabilities | ||
|
|
||
| <ApiRoles/> | ||
|
|
||
| * [Data Management](/docs/manage/users-roles/roles/role-capabilities/#data-management) | ||
| * View Parsers | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| --- | ||
| id: schema-base-management | ||
| title: Schema Base Management APIs | ||
| sidebar_label: Schema Base | ||
| description: Customize schema base management APIs. | ||
| --- | ||
|
|
||
| import useBaseUrl from '@docusaurus/useBaseUrl'; | ||
| import ApiIntro from '../reuse/api-intro.md'; | ||
| import ApiRoles from '../reuse/api-roles.md'; | ||
|
|
||
| <img src={useBaseUrl('img/icons/operations/schema.png')} alt="Thumbnail icon" width="50"/> | ||
|
|
||
| Use this API to customize schema used by [OpenTelemetry Remote Management Source Templates](/docs/send-data/opentelemetry-collector/remote-management/source-templates/). | ||
|
|
||
| ## Documentation | ||
|
|
||
| <ApiIntro/> | ||
|
|
||
| | Deployment | Documentation URL | | ||
| |:------------|:-------------------------------------------------------------| | ||
| | AU | https://api.au.sumologic.com/docs/#tag/schemaBaseManagement | | ||
| | CA | https://api.ca.sumologic.com/docs/#tag/schemaBaseManagement | | ||
| | DE | https://api.de.sumologic.com/docs/#tag/schemaBaseManagement | | ||
| | EU | https://api.eu.sumologic.com/docs/#tag/schemaBaseManagement | | ||
| | FED | https://api.fed.sumologic.com/docs/#tag/schemaBaseManagement | | ||
| | JP | https://api.jp.sumologic.com/docs/#tag/schemaBaseManagement | | ||
| | KR | https://api.kr.sumologic.com/docs/#tag/schemaBaseManagement | | ||
| | US1 | https://api.sumologic.com/docs/#tag/schemaBaseManagement | | ||
| | US2 | https://api.us2.sumologic.com/docs/#tag/schemaBaseManagement | | ||
|
|
||
| ## Required role capabilities | ||
|
|
||
| <ApiRoles/> | ||
|
|
||
| * [Data Management](/docs/manage/users-roles/roles/role-capabilities/#data-management) | ||
| * Manage Collectors | ||
| * View Collectors |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| --- | ||
| id: source-template-management | ||
| title: Source Template Management APIs | ||
| sidebar_label: Source Template | ||
| description: Manage OpenTelemetry Source Templates with APIs. | ||
| --- | ||
|
|
||
| import useBaseUrl from '@docusaurus/useBaseUrl'; | ||
| import ApiIntro from '../reuse/api-intro.md'; | ||
| import ApiRoles from '../reuse/api-roles.md'; | ||
|
|
||
| <img src={useBaseUrl('img/icons/operations/topology-explorer.png')} alt="Thumbnail icon" width="50"/> | ||
|
|
||
| Use this API to manage [OpenTelemetry Remote Management Source Templates](/docs/send-data/opentelemetry-collector/remote-management/source-templates/). | ||
|
|
||
| ## Documentation | ||
|
|
||
| <ApiIntro/> | ||
|
|
||
| | Deployment | Documentation URL | | ||
| |:------------|:-------------------------------------------------------------| | ||
| | AU | https://api.au.sumologic.com/docs/#tag/sourceTemplateManagementExternal | | ||
| | CA | https://api.ca.sumologic.com/docs/#tag/sourceTemplateManagementExternal | | ||
| | DE | https://api.de.sumologic.com/docs/#tag/sourceTemplateManagementExternal | | ||
| | EU | https://api.eu.sumologic.com/docs/#tag/sourceTemplateManagementExternal | | ||
| | FED | https://api.fed.sumologic.com/docs/#tag/sourceTemplateManagementExternal | | ||
| | JP | https://api.jp.sumologic.com/docs/#tag/sourceTemplateManagementExternal | | ||
| | KR | https://api.kr.sumologic.com/docs/#tag/sourceTemplateManagementExternal | | ||
| | US1 | https://api.sumologic.com/docs/#tag/sourceTemplateManagementExternal | | ||
| | US2 | https://api.us2.sumologic.com/docs/#tag/sourceTemplateManagementExternal | | ||
|
|
||
| ## Required role capabilities | ||
|
|
||
| <ApiRoles/> | ||
|
|
||
| * [Data Management](/docs/manage/users-roles/roles/role-capabilities/#data-management) | ||
| * Manage Collectors | ||
| * View Collectors |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.