Skip to content
GitLab
Projects Groups Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
  • Sign in / Register
  • S Storage
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
    • Locked Files
  • Issues 46
    • Issues 46
    • List
    • Boards
    • Service Desk
    • Milestones
    • Iterations
    • Requirements
  • Merge requests 19
    • Merge requests 19
  • 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
  • Storage
  • Issues
  • #62
Closed
Open
Issue created Apr 13, 2021 by ethiraj krishnamanaidu@ethirajReporter

Deprecation strategy - Schema management using storage service

As of today, we don't have deprecation strategy for OSDU APIs.

Context & Scope

Currently, Schema can be managed in two ways

  1. Using Storage service -- Flattened JSON
  2. Using Schema service -- Full JSON support

Storage service schema management doesn't support R3 schemas, so most consumers already using Schema service. We should avoid supporting schema management using two services. Currently, we will have to fix bugs in both services, so we are recommending to deprecate storage service schema management ASAP.

Suggestion

M6 Communication

  • Communicate to Forum Members and include the deprecation message in the M6 Release notes.
  • Update the PUT and GET API to return deprecated warning message(This version is deprecated and will be removed in M7. It will be gone after July 14th).

Wait period

  • Do we need data migration? If, so create schema/data migration and complete testing.

Delete the APIs in M7

  • Delete POST endpoint(/api/storage/v2/schema) in storage service.
  • Delete GET endpoint(/api/storage/v2/schema) in storage service
  • Delete DELETE endpoint(/api/storage/v2/schema) in storage service
  • Delete GET endpoint(/api/storage/v2/query/kinds) in storage service

Update on Jul 14

It was discovered last week that Admin UI is still using these APIs, and more time is needed for Admin UI to migrate to use schema service APIs. Thus, we can not remove these deprecated APIs in M7, and the updated proposal is to delay the removal to right before M8 code freeze, which is near end of Aug.

Edited Jul 15, 2021 by Chris Zhang
Assignee
Assign to
Time tracking