Usage and contributions

This article targets developers and potential contributors. If you like to cite this software, the “Cite this repository” button on the right side on GitHub will be helpful for you. The information in there is generated from the file citation.cff.

Developing applications using a Typed PID Maker instance

The Typed PID Maker offers a REST interface to use for other applications. The API for a specific instance depends partially on its configuration details. Therefore, the best documentation is the one it offers at runtime (openAPI/swagger) at $domain:$port/swagger-ui.html (for example http://localhost:8090/swagger-ui.html).

We keep the API documentation on our webpage up-to-date, so it should always reflect the API of the newest version. Again, note some APIs might not be available depending on the configuration. Also, some of the deployment notes will be interesting to client developers alike.

Search example

The Typed PID Maker exposes the search interface of Elasticsearch through its REST interface, if it is configured to do so. For testing purposes, the search can also be executed via the provided swagger interface (default location: http://localhost:8090/swagger-ui.html). For example, with the following request body you will get all record information:

{
  "query": {
    "regexp": {
      "pid": {
        "value": ".*",
        "flags": "ALL",
        "case_insensitive": true
      }
    }
  }
}

You can also use other http clients, like CURL. A CURL request (which may be provided by swagger) may look like this:

curl -X 'POST' \
  'http://localhost:8090/api/v1/search?page=0&size=20' \
  -H 'accept: application/hal+json' \
  -H 'Content-Type: application/json' \
  -d '{
  "query": {
    "regexp": {
      "pid": {
        "value": ".*",
        "flags": "ALL",
        "case_insensitive": true
      }
    }
  }
}'

The records are stored in a search index called typedpidmaker. There is an extensive documentation of the Elastic query language.

Suggestions and contributions to the Typed PID Maker

The Typed PID Maker is developed openly on our GitHub repository. If you have a feature request or want to report a bug, please open an issue.

If you want to contribute code, consider our contribution guidelines. All code contributions are licensed under the Apache 2.0 license. Our technology stack involves the Java programming language and the Spring Framework.