Skip to content
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

update api docs #3558

Merged
merged 31 commits into from
Nov 25, 2024
Merged

update api docs #3558

merged 31 commits into from
Nov 25, 2024

Conversation

ashucoder9
Copy link
Member

No description provided.

Signed-off-by: Ashutosh Tripathi <[email protected]>
Signed-off-by: Ashutosh Tripathi <[email protected]>
@ashucoder9 ashucoder9 changed the title update service.md for p-chain api update api docs Nov 21, 2024
Signed-off-by: Ashutosh Tripathi <[email protected]>
Signed-off-by: Ashutosh Tripathi <[email protected]>
Signed-off-by: Ashutosh Tripathi <[email protected]>
Signed-off-by: Ashutosh Tripathi <[email protected]>
Signed-off-by: Ashutosh Tripathi <[email protected]>
Signed-off-by: Ashutosh Tripathi <[email protected]>
Signed-off-by: Ashutosh Tripathi <[email protected]>
Signed-off-by: Ashutosh Tripathi <[email protected]>
Signed-off-by: Ashutosh Tripathi <[email protected]>
Signed-off-by: Ashutosh Tripathi <[email protected]>
Signed-off-by: Ashutosh Tripathi <[email protected]>
Signed-off-by: Ashutosh Tripathi <[email protected]>
Signed-off-by: Ashutosh Tripathi <[email protected]>
Signed-off-by: Ashutosh Tripathi <[email protected]>
Signed-off-by: Ashutosh Tripathi <[email protected]>
Signed-off-by: Ashutosh Tripathi <[email protected]>
Signed-off-by: Ashutosh Tripathi <[email protected]>
Signed-off-by: Ashutosh Tripathi <[email protected]>
Signed-off-by: Ashutosh Tripathi <[email protected]>
@ashucoder9
Copy link
Member Author

@meaghanfitzgerald the headers of md docs are removed to match the style of docs website remote content loader

@meaghanfitzgerald
Copy link
Contributor

<Callout title="Note">
The Admin API is disabled by default for security reasons. To run a node with the Admin API enabled, use [`config flag --api-admin-enabled=true`](/nodes/configure/configs-flags#--api-admin-enabled-boolean).

This API set is for a specific node, it is unavailable on the [public server](/tooling/rpc-providers).
</Callout>

have you tested to make sure the formatting will be applied correctly? these files are .md, not .mdx

@ashucoder9
Copy link
Member Author

<Callout title="Note">
The Admin API is disabled by default for security reasons. To run a node with the Admin API enabled, use [`config flag --api-admin-enabled=true`](/nodes/configure/configs-flags#--api-admin-enabled-boolean).

This API set is for a specific node, it is unavailable on the [public server](/tooling/rpc-providers).
</Callout>

have you tested to make sure the formatting will be applied correctly? these files are .md, not .mdx

yes, we parse the raw content and save a .mdx file when remote content loads, works good

Signed-off-by: Ashutosh Tripathi <[email protected]>
Signed-off-by: Ashutosh Tripathi <[email protected]>
Signed-off-by: Ashutosh Tripathi <[email protected]>
Signed-off-by: Ashutosh Tripathi <[email protected]>
Signed-off-by: Ashutosh Tripathi <[email protected]>
Signed-off-by: Ashutosh Tripathi <[email protected]>
api/admin/service.md Outdated Show resolved Hide resolved
api/admin/service.md Outdated Show resolved Hide resolved
@StephenButtolph StephenButtolph added this to the v1.11.14 milestone Nov 25, 2024
@StephenButtolph StephenButtolph added the documentation Improvements or additions to documentation or examples label Nov 25, 2024
@StephenButtolph StephenButtolph merged commit 48e148d into master Nov 25, 2024
23 checks passed
@StephenButtolph StephenButtolph deleted the new-endpoints branch November 25, 2024 03:50
@StephenButtolph StephenButtolph modified the milestones: v1.11.14, v1.12.0 Dec 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation or examples
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update service.md to reflect all API endpoints in service.go in avalanchego
3 participants