Home

Numtracker - file templating and numbering service

Interacting with the service

All interaction should be made via the graphQL interface. To make this easier for testing or one-off uses, there are two client interfaces to this API included - the graphiql IDE and the CLI client.

• GraphQL

  This is the main API for interacting with the service. Its schema is defined in [static/service_schema.graphql] or via the built command as numtracker schema.

• Python

  Basic overview of making graphQL requests from python. This does not use any third party libraries but should be enough for basic use.

• Graphiql

  The third party graphQL IDE made available on the /graphiql endpoint when the service is running. This offers autocompletion and documentation to make the API more discoverable. On the downside, when interacting with an authenticated service, this requires more work to provide authentication.

• CLI

  To make it easier to interact with an authenticated service or to use the service without a browser, there is a CLI client that covers most of the API and makes it easier to request and pass an auth token.

Configuring a new beamline

Configuring a new beamline requires some configuration via the graphQL API and potentially a change to the deployment if GDA interaction is required.

For details, see Configuring a new beamline