Skip to content

API

Open API 3.0 - Swagger

  • Swagger UI : https://host/context-path/swagger (will redirect to https://host/context-path/swagger-ui/index.html)
  • api-docs (JSON ) : https://host/context-path/api-docs
  • api-docs (YAML) : https://host/context-path/api-docs.yaml

All the Swagger and OpenAPI related common properties are managed here swagger.properties

Usage

Access rights

To operate with SecretRepositories user should have any of listed entitlements group: - service.secret.viewer - service.secret.editor - service.secret.admin

RBAC

Access to secrets is partition-wide, so secret service user will have opportunity to operate all secrets and secret repositories in his partition.

Use cases

  1. OSDU Data manager operates with credentials from another data platform or external data source.
  2. OSDU Data manager operates with CORS headers on external API endpoints.
  3. OSDU Data manager operates with public key certificate that represents a trusted IdP. He wants to store that public key certificate in a location, so that the cloud-provider services can pick it up and provision it/authorise it to access data platform instance.
  4. OSDU service accounts operates with secrets for access to online services (e.g., API keys).

Version info endpoint

For deployment available public /info endpoint, which provides build and git related information.

Example response:

{
    "groupId": "org.opengroup.osdu",
    "artifactId": "storage-gc",
    "version": "0.10.0-SNAPSHOT",
    "buildTime": "2021-07-09T14:29:51.584Z",
    "branch": "feature/GONRG-2681_Build_info",
    "commitId": "7777",
    "commitMessage": "Added copyright to version info properties file",
    "connectedOuterServices": [
      {
        "name": "elasticSearch",
        "version":"..."
      },
      {
        "name": "postgresSql",
        "version":"..."
      },
      {
        "name": "redis",
        "version":"..."
      }
    ]
}

This endpoint takes information from files, generated by spring-boot-maven-plugin, git-commit-id-plugin plugins. Need to specify paths for generated files to matching properties:

  • osdu.version.info.buildPropertiesPath
  • osdu.version.info.gitPropertiesPath