GraphQL documentation

[ingoratsdorf]

Is there a documentation for the reasonably new graphql backend and how to query it?
I managed to authorize and query but all I am getting back is "null".

Example:
curl 'http://192.168.100.27:20212/graphql' -X POST -H 'Authorization:Bearer t_yu8Xk5T6oacn51ywjSuG' -H 'content-type: application/json' --data '{ "query":"{ devices(status:connected) }" }'

[jokob-sk]

Hey @ingoratsdorf,

I didn't think to write up one, but can do in future.

Check out the schema definition, you are probably after the devStatus field, with the value set to connected:

https://github.com/jokob-sk/NetAlertX/blob/main/server/graphql_server/graphql_schema.py

You can probably feed in the schema into chatgpt and ask for examples.

Hope this helps,
J

[ingoratsdorf]

Never been a big friend of GitHUB CoPilot, but:

Can you show an example for a query using the graphql schema in https://github.com/jokob-sk/NetAlertX/blob/main/server/graphql_server/graphql_schema.py

result:

Certainly! Here is an example of how you can perform a GraphQL query using curl to fetch device data from the GraphQL schema defined in server/graphql_server/graphql_schema.py.

Example Query to Fetch Devices

First, let's define the GraphQL query to fetch devices with pagination and sorting options.

query GetDevices($options: PageQueryOptionsInput) {
  devices(options: $options) {
    devices {
      rowid
      devMac
      devName
      devOwner
      devType
      devVendor
      devLastConnection
      devStatus
    }
    count
  }
}

curl Command

You can use the following curl command to execute the query. Make sure to replace http://your-graphql-server.com/graphql with the actual URL of your GraphQL server.

curl -X POST http://your-graphql-server.com/graphql \
-H "Content-Type: application/json" \
-d '{
  "query": "query GetDevices($options: PageQueryOptionsInput) { devices(options: $options) { devices { rowid devMac devName devOwner devType devVendor devLastConnection devStatus } count } }",
  "variables": {
    "options": {
      "page": 1,
      "limit": 10,
      "sort": [{ "field": "devName", "order": "asc" }],
      "search": "",
      "status": "connected"
    }
  }
}'

Explanation:

1. GraphQL Query:

   • The query parameter contains the GraphQL query as a string.
   • The variables parameter contains the input variables for the query.

2. Query Variables:

   • page: Specifies the page number of results to fetch.
   • limit: Specifies the number of results per page.
   • sort: Specifies the sorting options, with field being the field to sort by and order being the sort order (asc for ascending).
   • search: A search term to filter the devices.
   • status: The status filter to apply (e.g., "connected").

3. curl Command:

   • The -X POST option specifies that we are making a POST request.
   • The -H "Content-Type: application/json" option sets the content type of the request to JSON.
   • The -d option provides the request payload, which includes the GraphQL query and variables.

Sample Response

The response will be in JSON format, similar to the following:

{
  "data": {
    "devices": {
      "devices": [
        {
          "rowid": 1,
          "devMac": "00:11:22:33:44:55",
          "devName": "Device 1",
          "devOwner": "Owner 1",
          "devType": "Type 1",
          "devVendor": "Vendor 1",
          "devLastConnection": "2025-01-01T00:00:00Z",
          "devStatus": "connected"
        },
        {
          "rowid": 2,
          "devMac": "66:77:88:99:AA:BB",
          "devName": "Device 2",
          "devOwner": "Owner 2",
          "devType": "Type 2",
          "devVendor": "Vendor 2",
          "devLastConnection": "2025-01-02T00:00:00Z",
          "devStatus": "connected"
        }
      ],
      "count": 2
    }
  }
}

This example demonstrates how to use curl to perform a GraphQL query against the provided schema, fetching a list of devices with their details, including pagination and sorting options. Adjust the query and variables as needed to match your specific requirements.

[ingoratsdorf]

Bloody amazing!

[jokob-sk]

:) it's really a great time to get into anything new if you can ask AI anything and get a decent response. I used the above to update the API docs a bit, let me know if I missed anything: https://github.com/jokob-sk/NetAlertX/blob/main/docs/API.md