Skip to content
GitLab
Projects Groups Topics Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
  • Register
  • Sign in
  • S Storage
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributor statistics
    • Graph
    • Compare revisions
    • Locked files
  • Issues 52
    • Issues 52
    • List
    • Boards
    • Service Desk
    • Milestones
    • Iterations
    • Requirements
  • Merge requests 12
    • Merge requests 12
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
    • Test cases
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Packages and registries
    • Packages and registries
    • Package Registry
    • Container Registry
    • Terraform modules
  • 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
  • Merge requests
  • !404

update Storage API spec

  • Review changes

  • Download
  • Patches
  • Plain diff
Merged An Ngo requested to merge UpdateStorageDoc into master Apr 22, 2022
  • Overview 3
  • Commits 1
  • Pipelines 2
  • Changes 1

Type of change

  • Bug Fix
  • Feature

Please provide link to gitlab issue or ADR(Architecture Decision Record)
#37 (closed)

Does this introduce a change in the core logic?

  • [NO]

Does this introduce a change in the cloud provider implementation, if so which cloud?

  • AWS
  • Azure
  • GCP
  • IBM

Does this introduce a breaking change?

  • [NO]

What is the current behavior?

The Storage API spec does not match the implementation capabilities. Here the two issues:

  • batch record read with normalization (as used by the indexer).
  • patch capability for acl, legal and the likes, which does not bump the version.

Structural error at info.contact.email should match format "email" format: email Jump to line 9 Structural error at paths./records/delete.post should NOT have additional properties additionalProperty: requestBody Jump to line 200 Structural error at paths./records/delete.post.parameters.0 should NOT have additional properties additionalProperty: schema Jump to line 208 Structural error at paths./records/delete.post.parameters.0 should have required property 'type' missingProperty: type Jump to line 208 Structural error at paths./records/delete.post.responses.207 should NOT have additional properties additionalProperty: content Jump to line 225 Semantic error at paths./records/delete.post.responses.207.content.application/json.schema.items.$ref $refs must reference a valid location in the document Jump to line 232 Semantic error at paths./records/delete.post.security.0 Security requirements must match a security definition Jump to line 238 Semantic error at paths./records/delete.post.security.1 Security requirements must match a security definition Jump to line 239 Structural error at definitions.MultiRecordIds.properties.attributes should NOT have additional properties additionalProperty: allowEmptyValue Jump to line 728 Structural error at definitions.Record.properties.history should NOT have additional properties additionalProperty: allowEmptyValue Jump to line 849 Structural error at definitions.RecordHistory.properties.parents should NOT have additional properties additionalProperty: allowEmptyValue Jump to line 875 Structural error at definitions.RecordBulkUpdateParam.properties.query should NOT have additional properties additionalProperty: allowEmptyValue Jump to line 957 Structural error at definitions.RecordBulkUpdateParam.properties.ops should NOT have additional properties additionalProperty: allowEmptyValue Jump to line 961 Semantic error at definitions.RecordQuery.properties.ids Schemas with 'type: array', require a sibling 'items: ' field Jump to line 996

What is the new/expected behavior?

Update Storage API spec to include Batch record read with normalization; fixed swagger structural and semantic errors.

Have you added/updated Unit Tests and Integration Tests?

N/A

Any other useful information

N/A

Edited May 12, 2022 by Yauheni Lesnikau
Assignee
Assign to
Reviewers
Request review from
Time tracking
Source branch: UpdateStorageDoc