Skip to content
GitLab
Projects Groups Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
  • Sign in
  • S Schema
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
    • Locked Files
  • Issues 24
    • Issues 24
    • List
    • Boards
    • Service Desk
    • Milestones
    • Iterations
    • Requirements
  • Merge requests 8
    • Merge requests 8
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
    • Test Cases
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Packages and registries
    • Packages and registries
    • Package Registry
    • Container Registry
    • Infrastructure Registry
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Code review
    • Insights
    • Issue
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • Open Subsurface Data Universe SoftwareOpen Subsurface Data Universe Software
  • Platform
  • System
  • Schema
  • Issues
  • #67
Closed
Open
Issue created Sep 07, 2021 by Aman Verma@amavermaMaintainer

API description for schemas/system API

  • What are system schemas
  • How do you identify a system schema
  • How to create system schema

What are system schemas

System schemas are schemas which are available to all the data partitions within an OSDU deployment out of the box.

How do you identify a system schema

The scope field is set to SHARED for system schemas in the schemaInfo section. Sample schemaInfo for system schemas:

{
  "schemaInfo": {
    "schemaIdentity": {
      "authority": "osdu",
      "source": "wks",
      "entityType": "work-product-component--WellLog",
      "schemaVersionMajor": 1,
      "schemaVersionMinor": 0,
      "schemaVersionPatch": 0,
      "id": "osdu:wks:work-product-component--WellLog:1.0.0"
    },
    "createdBy": "OSDU Data Definition Group",
    "scope": "SHARED",
    "status": "DEVELOPMENT"
  },
  "schema": {
  }
}

How to create system schema

You can create system schemas by (to be introduced) schemas/system endpoint in your schema service. Find more details in the ADR: #51

The schemas/system endpoint differs from the regular /schema endpoint in two ways:

  1. It does not accept the data-partition-id header. Since the schemas being created belong to no data-partition in particular, the API does not allow users to pass data-partition-id header. If you do pass the header, the request would fail with error indicating data-partition-id header should not be supplied.
  2. The API works on service principal auth only. The authorization mechanism is similar to what we have in partition service related APIs. Refer example https://community.opengroup.org/osdu/platform/system/partition/-/blob/master/partition-core/src/main/java/org/opengroup/osdu/partition/api/PartitionApi.java#L49
Edited Sep 07, 2021 by Aman Verma
Assignee
Assign to
Time tracking