Skip to main content

Sample Usage

Let's discover Docusaurus in less than 5 minutes.

Getting Started

Get started by creating a new site.

Or try Docusaurus immediately with docusaurus.new.

What you'll need

  • Node.js version 16.14 or above:
    • When installing Node.js, you are recommended to check all checkboxes related to dependencies.

What you'll need

  • Node.js version 16.14 or above:
    • When installing Node.js, you are recommended to check all checkboxes related to dependencies.

Generate a new site

Generate a new Docusaurus site using the classic template.

The classic template will automatically be added to your project after you run the command:

npm init docusaurus@latest my-website classic

You can type this command into Command Prompt, Powershell, Terminal, or any other integrated terminal of your code editor.

The command also installs all necessary dependencies you need to run Docusaurus.

Start your site

Run the development server:

cd my-website
npm run start

The cd command changes the directory you're working with. In order to work with your newly created Docusaurus site, you'll need to navigate the terminal there.

The npm run start command builds your website locally and serves it through a development server, ready for you to view at http://localhost:3000/.

Open docs/intro.md (this page) and edit some lines: the site reloads automatically and displays your changes.

Image Usage

Image Clickable

Simple Database GUI
Simple Database GUI

Image Clickable with Fix Width

Simple Database GUI

Image Default

Simple Database GUI
Simple Database GUI

Video Usage

Info Usage

This is Info

In versions v2.0.0 and above, databases can be connected and removed dynamically without having to restart the Engine instance.

This is Tip

You can connect to databases by using environment variables, the raw connection string or connection parameters.

This is Note

You can connect to databases by using environment variables, the raw connection string or connection parameters.

This is Caution

You can connect to databases by using environment variables, the raw connection string or connection parameters.

This is Danger

You can connect to databases by using environment variables, the raw connection string or connection parameters.

Tabs Usage

This is an apple 🍎

Diagram Usage

Example Mermaid diagram Refer this link, for more info

Table

FieldDescription
RegionThe region of the datacenter where your New Relic account stores its data. Read more about regions on New Relic docs.
API KeyAPI keys are unique to your organization. An API key is required by the New Relic API to submit metrics and events to New Relic. You can get the API key from here if you are in New Relic US region and here if you're in New Relic EU region.
HostThe name of the originating host of the log and metrics.
Custom AttributesCustom Attributes associated with your logs and metrics. A default source tag dronahq-cloud-metrics is added to all exported logs and metrics. Attributes project_id and project_name are added to all exported metrics.
Service NameThe name of the application or service generating the log events.

API Documentation

GET
/scim/v2/users
POST
/scim/v2/users
PUT
/scim/v2/users
DELETE
/scim/v2/users
PATCH
/scim/v2/users
HEAD
/scim/v2/users
OPTIONS
/scim/v2/users

Sample API Documentation

List users

Retrieve a list of users based on the provided email filter

GET
/api/scim/v2/users

Headers

KeyDescription
Acceptapplication/json
AuthorizationBearer token

Path parameters

ParameterTypeDescription
filter (optional)StringFilter users by email ID
startIndex (optional)IntegerIndex of the first user to be returned
count (optional)IntegerNumber of users to be returned

Query parameters

ParameterTypeDescription
filter (optional)StringFilter users by email ID
startIndex (optional)IntegerIndex of the first user to be returned
count (optional)IntegerNumber of users to be returned

Body parameters

ParameterTypeDescription
filter (optional)StringFilter users by email ID
startIndex (optional)IntegerIndex of the first user to be returned
count (optional)IntegerNumber of users to be returned

Example cURL

curl --location 'http://localhost:8080/api/scim/v2/users' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXX'

Responses

Status CodeDescriptionRespomse
200Successapplication/json
401Unauthorizedempty

Sample response

200 : Success

{
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:ListResponse"
],
"Resources": [
{
"groups": [
{
"display": "Default",
"value": 3966
}
],
"emails": [
{
"value": "pronghor@bears-rosessale.ru",
"primary": true
}
],
"meta": {
"location": "https://studio.dronahq.com/api/scim/v2/Users/563504",
"created": "2023-08-04T08:38:02.3732123Z"
},
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User"
],
"name": {
"givenName": null,
"familyName": null
},
"photos": [],
"nickName": null,
"userName": "pronghor@bears-rosessale.ru",
"displayName": "Rishabh Jain",
"externalId": null,
"timezone": null,
"title": null,
"active": true,
"profileUrl": "",
"id": "563504"
}
],
"startIndex": 1,
"totalResults": 50,
"itemsPerPage": 1
}