{"items":[{"type":"link","label":"Schema APIs","link":"/solutions/core-service/apis/osdu-schema-service","routeSlug":"/solutions/core-service/apis/osdu-schema-service","content":{"contentType":"overview","meta":{"name":"Schema APIs"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"OSDU-Schema-Service.json","url":"/_bundle/solutions/core-service/apis/OSDU-Schema-Service.json?download"},{"kind":"download","label":"OSDU-Schema-Service.yaml","url":"/_bundle/solutions/core-service/apis/OSDU-Schema-Service.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"URL","titleTranslationKey":"info.contact.url","label":"https://customersupport.digital.slb.com","url":"https://customersupport.digital.slb.com"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://as5.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (SGP)"},{"url":"https://br5.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB SaaS OSDU (BRS)"},{"url":"https://eu5.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (WEU)"},{"url":"https://eu6.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB SaaS OSDU (EUT)"},{"url":"https://eu7.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (MDE)"},{"url":"https://us5.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (PSC)"},{"url":"https://us7.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (USC)"},{"url":"https://us8.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (WUS)"},{"url":"https://as6.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (SAS)"},{"url":"https://eu8.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (SWC)"},{"url":"https://as7.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (MYW)"},{"url":"https://za1.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (ZAN)"},{"url":"/_mock/solutions/core-service/apis/osdu-schema-service","description":"Mock server","isMockServer":true}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Schema APIs (1.0.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Schema Service enables schema management in the Data Platform and offers an"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"implementation of the schema standard."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Schema Service handles schema life cycle to help with the development of schemas in the Ecosystem."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"963f2cc6915e479fa0fcb73ec2ec90e7\n","language":"plain","title":"Client ID"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"963f2cc6915e479fa0fcb73ec2ec90e7\n"},"children":[]}]}]}],"sectionId":"/"}],"sectionId":"/"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/schema-states"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Schema States"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This lifecycle consists of three states - \"DEVELOPMENT\", \"PUBLISHED\" and \"OBSOLETE\"."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DEVELOPMENT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Denotes that a Schema is in draft or evolutionary phase. Schema in this state is mutable."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PUBLISHED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - A Schema can directly be created in published state or moved from the DEVELOPMENT state to the PUBLISHED state. A Schema in published state is immutable."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OBSOLETE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Schema can be marked as obsolete once they are no more in use. You can change DEVELOPMENT state schemas to OBSOLETE state."},"children":[]}]}]}]}]}]}],"sectionId":"/section/schema-states"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/schema-scopes"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Schema Scopes"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INTERNAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - A schema defined in a certain data partition and accessible to only the users of that data partition is said to have \"INTERNAL\" scope."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SHARED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The Managed Planning Data Foundation makes certain standard schema available out of the box to all OSDU data partitions. These schema will have scope as \"SHARED\" by default and it should be created using system endpoint."},"children":[]}]}]}]}]}]}],"sectionId":"/section/schema-scopes"}]}]}},{"type":"link","label":"Schema States","link":"/solutions/core-service/apis/osdu-schema-service/section/schema-states","routeSlug":"/solutions/core-service/apis/osdu-schema-service/section/schema-states","content":null},{"type":"link","label":"Schema Scopes","link":"/solutions/core-service/apis/osdu-schema-service/section/schema-scopes","routeSlug":"/solutions/core-service/apis/osdu-schema-service/section/schema-scopes","content":null},{"type":"group","label":"Schema","link":"/solutions/core-service/apis/osdu-schema-service/schema","routeSlug":"/solutions/core-service/apis/osdu-schema-service/schema","items":[{"label":"Adds a schema to the schema repository with status INTERNAL.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/core-service/apis/osdu-schema-service/schema/create schema","routeSlug":"/solutions/core-service/apis/osdu-schema-service/schema/create schema","metadata":{"seo":{"title":"Adds a schema to the schema repository with status INTERNAL.","description":"Adds a schema to the schema repository. The schemaIdentity must be unique. The authority, source and entityType will be registered if not present. If lower minor versions are registered the service validates the new schema against breaking changes; if breaking changes are discovered the request fails.  Note: The schema must not reference other schemas with status DEVELOPMENT. By default scope to a schema will be set as INTERNAL  Required roles 'users.datalake.editors' or 'users.datalake.admins' groups to create schema."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create Schema","name":"Adds a schema to the schema repository with status INTERNAL.","deprecated":false,"isWebhook":false,"pointer":"/paths/~1schema/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Adds a schema to the schema repository with status INTERNAL.","isWebhook":false,"deprecated":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Adds a schema to the schema repository. The schemaIdentity must be unique. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authority"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"source"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"entityType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be registered if not present. If lower minor versions are registered the service validates the new schema against breaking changes; if breaking changes are discovered the request fails. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The schema must not reference other schemas with status "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DEVELOPMENT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". By default scope to a schema will be set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INTERNAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required roles"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 'users.datalake.editors' or 'users.datalake.admins' groups to create schema."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"User Token from SLB Authenticator Service"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"data-partition-id","in":"header","schemaId":"schema_0","description":"desired data partition id","required":true}],"pointer":"/paths/~1schema/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SchemaRequest"}},"schemaId":"components/schemas/SchemaRequest","pointer":"/paths/~1schema/post/requestBody","description":"Schema description and schema to add"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/schema","servers":[{"url":"https://as5.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (SGP)"},{"url":"https://br5.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB SaaS OSDU (BRS)"},{"url":"https://eu5.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (WEU)"},{"url":"https://eu6.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB SaaS OSDU (EUT)"},{"url":"https://eu7.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (MDE)"},{"url":"https://us5.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (PSC)"},{"url":"https://us7.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (USC)"},{"url":"https://us8.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (WUS)"},{"url":"https://as6.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (SAS)"},{"url":"https://eu8.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (SWC)"},{"url":"https://as7.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (MYW)"},{"url":"https://za1.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (ZAN)"},{"url":"/_mock/solutions/core-service/apis/osdu-schema-service","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"data-partition-id","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SchemaRequest"}},"responseCodes":["201","400","401","403"],"pointer":"/schema","href":"schema/create schema","openApiOperationId":"Create Schema","summary":"Adds a schema to the schema repository with status INTERNAL."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://as5.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (SGP)"},{"url":"https://br5.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB SaaS OSDU (BRS)"},{"url":"https://eu5.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (WEU)"},{"url":"https://eu6.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB SaaS OSDU (EUT)"},{"url":"https://eu7.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (MDE)"},{"url":"https://us5.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (PSC)"},{"url":"https://us7.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (USC)"},{"url":"https://us8.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (WUS)"},{"url":"https://as6.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (SAS)"},{"url":"https://eu8.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (SWC)"},{"url":"https://as7.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (MYW)"},{"url":"https://za1.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (ZAN)"},{"url":"/_mock/solutions/core-service/apis/osdu-schema-service","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/SchemaRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SchemaRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Schema created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SchemaInfo"}},"schemaId":"components/schemas/SchemaInfo"},{"code":"400","description":"Bad user input. Mandatory fields missing or unacceptable value passed to API","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseFormat"}},"schemaId":"components/schemas/ErrorResponseFormat"},{"code":"401","description":"Unknown or invalid user.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseFormat"}},"schemaId":"components/schemas/ErrorResponseFormat"},{"code":"403","description":"User not authorised to access the API","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseFormat"}},"schemaId":"components/schemas/ErrorResponseFormat"}],"pointer":"/paths/~1schema/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/SchemaInfo","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SchemaInfo"}}},{"code":"400","schemaId":"components/schemas/ErrorResponseFormat","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseFormat"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseFormat","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseFormat"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseFormat","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseFormat"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/schema/create schema"}],"panels":[]}]},"httpPath":"/schema"},{"label":"Updates/Creates a schema in DEVELOPMENT status with INTERNAL scope","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/core-service/apis/osdu-schema-service/schema/update schema","routeSlug":"/solutions/core-service/apis/osdu-schema-service/schema/update schema","metadata":{"seo":{"title":"Updates/Creates a schema in DEVELOPMENT status with INTERNAL scope","description":"Creates a new schema or updates an already existing schema with status DEVELOPMENT in the schema repository. If a user tries to create/update a schema with status other then DEVELOPMENT, API will throw an exception. Any schema instance with the same schemaIdentity is replaced (in contrast to the immutability of PUBLISHED or OBSOLETE schemas). A schema state can also be changed from DEVELOPMENT to PUBLISHED or OBSOLETE while updating schema content or by providing the same schema content.  Note: The schema may refer to other schema definitions in DEVELOPMENT state. If those schemas are updated themselves, it is the schema owner's responsibility to PUT the dependent schemas again to update the schemas. Scope for a schema can't be updated, its a system defined value. Required roles  'users.datalake.editors' or 'users.datalake.admins' groups to update schema."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update Schema","name":"Updates/Creates a schema in DEVELOPMENT status with INTERNAL scope","deprecated":false,"isWebhook":false,"pointer":"/paths/~1schema/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates/Creates a schema in DEVELOPMENT status with INTERNAL scope","isWebhook":false,"deprecated":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a new schema or updates an already existing schema with status "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DEVELOPMENT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the schema repository. If a user tries to create/update a schema with status other then "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DEVELOPMENT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", API will throw an exception. Any schema instance with the same schemaIdentity is replaced (in contrast to the immutability of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PUBLISHED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OBSOLETE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" schemas). A schema state can also be changed from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DEVELOPMENT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PUBLISHED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OBSOLETE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" while updating schema content or by providing the same schema content. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The schema may refer to other schema definitions in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DEVELOPMENT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state. If those schemas are updated themselves, it is the schema owner's responsibility to PUT the dependent schemas again to update the schemas. Scope for a schema can't be updated, its a system defined value. Required roles  'users.datalake.editors' or 'users.datalake.admins' groups to update schema."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"User Token from SLB Authenticator Service"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"data-partition-id","in":"header","schemaId":"schema_0","description":"desired data partition id","required":true}],"pointer":"/paths/~1schema/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SchemaRequest"}},"schemaId":"components/schemas/SchemaRequest","pointer":"/paths/~1schema/put/requestBody","description":"SchemaRequest"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/schema","servers":[{"url":"https://as5.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (SGP)"},{"url":"https://br5.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB SaaS OSDU (BRS)"},{"url":"https://eu5.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (WEU)"},{"url":"https://eu6.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB SaaS OSDU (EUT)"},{"url":"https://eu7.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (MDE)"},{"url":"https://us5.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (PSC)"},{"url":"https://us7.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (USC)"},{"url":"https://us8.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (WUS)"},{"url":"https://as6.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (SAS)"},{"url":"https://eu8.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (SWC)"},{"url":"https://as7.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (MYW)"},{"url":"https://za1.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (ZAN)"},{"url":"/_mock/solutions/core-service/apis/osdu-schema-service","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"data-partition-id","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SchemaRequest"}},"responseCodes":["200","201","400","401","403"],"pointer":"/schema","href":"schema/update schema","openApiOperationId":"Update Schema","summary":"Updates/Creates a schema in DEVELOPMENT status with INTERNAL scope"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://as5.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (SGP)"},{"url":"https://br5.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB SaaS OSDU (BRS)"},{"url":"https://eu5.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (WEU)"},{"url":"https://eu6.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB SaaS OSDU (EUT)"},{"url":"https://eu7.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (MDE)"},{"url":"https://us5.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (PSC)"},{"url":"https://us7.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (USC)"},{"url":"https://us8.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (WUS)"},{"url":"https://as6.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (SAS)"},{"url":"https://eu8.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (SWC)"},{"url":"https://as7.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (MYW)"},{"url":"https://za1.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (ZAN)"},{"url":"/_mock/solutions/core-service/apis/osdu-schema-service","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/SchemaRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SchemaRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Schema updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SchemaInfo"}},"schemaId":"components/schemas/SchemaInfo"},{"code":"201","description":"Schema created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SchemaInfo"}},"schemaId":"components/schemas/SchemaInfo"},{"code":"400","description":"Bad user input. Mandatory fields missing or unacceptable value passed to API","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseFormat"}},"schemaId":"components/schemas/ErrorResponseFormat"},{"code":"401","description":"Unknown or invalid user.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseFormat"}},"schemaId":"components/schemas/ErrorResponseFormat"},{"code":"403","description":"User not authorised to access the API","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseFormat"}},"schemaId":"components/schemas/ErrorResponseFormat"}],"pointer":"/paths/~1schema/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SchemaInfo","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SchemaInfo"}}},{"code":"201","schemaId":"components/schemas/SchemaInfo","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SchemaInfo"}}},{"code":"400","schemaId":"components/schemas/ErrorResponseFormat","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseFormat"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseFormat","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseFormat"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseFormat","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseFormat"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/schema/update schema"}],"panels":[]}]},"httpPath":"/schema"},{"label":"Get identity information for all available schema","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/core-service/apis/osdu-schema-service/schema/searchschemainforepository","routeSlug":"/solutions/core-service/apis/osdu-schema-service/schema/searchschemainforepository","metadata":{"seo":{"title":"Get identity information for all available schema","description":"The API returns a list of all schemas in the specific {data-partition-Id} and the list of available shared schemas in chronological order based on \"dateCreated\". If filter criteria is specific then the schemas matching the criteria will be returned. If \"latestestVersion=true\", then result will only contain the latest version of the schema for a given Authority, Source & Entity. Required roles 'users.datalake.viewers' or 'users.datalake.editors' or 'users.datalake.admins'"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchSchemaInfoRepository","name":"Get identity information for all available schema","deprecated":false,"isWebhook":false,"pointer":"/paths/~1schema/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get identity information for all available schema","isWebhook":false,"deprecated":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The API returns a list of all schemas in the specific {data-partition-Id} and the list of available shared schemas in chronological order based on \"dateCreated\". If filter criteria is specific then the schemas matching the criteria will be returned. If \"latestestVersion=true\", then result will only contain the latest version of the schema for a given Authority, Source & Entity. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required roles"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 'users.datalake.viewers' or 'users.datalake.editors' or 'users.datalake.admins'"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"User Token from SLB Authenticator Service"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"authority","in":"query","schemaId":"schema_1","description":"pass an optional string to search for a specific authority"},{"name":"source","in":"query","schemaId":"schema_2","description":"pass an optional string to search for a specific source"},{"name":"entityType","in":"query","schemaId":"schema_3","description":"pass an optional string to search for a specific entityType"},{"name":"schemaVersionMajor","in":"query","schemaId":"schema_0","description":"pass an optional string to search for a specific schemaVersionMajor"},{"name":"schemaVersionMinor","in":"query","schemaId":"schema_0","description":"pass an optional string to search for a specific schemaVersionMinor"},{"name":"schemaVersionPatch","in":"query","schemaId":"schema_0","description":"pass an optional string to search for a specific schemaVersionPatch"},{"name":"status","in":"query","schemaId":"schema_4","description":"The schema status specification"},{"name":"scope","in":"query","schemaId":"schema_5","description":"The scope or schema visibility specification"},{"name":"latestVersion","in":"query","schemaId":"schema_6","description":"if True, only return the latest version"},{"name":"limit","in":"query","schemaId":"schema_7","description":"maximum number of schema records to return"},{"name":"offset","in":"query","schemaId":"schema_8","description":"number of records to skip for pagination"}],"pointer":"/paths/~1schema/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"data-partition-id","in":"header","schemaId":"schema_0","description":"desired data partition id","required":true}],"pointer":"/paths/~1schema/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/schema","servers":[{"url":"https://as5.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (SGP)"},{"url":"https://br5.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB SaaS OSDU (BRS)"},{"url":"https://eu5.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (WEU)"},{"url":"https://eu6.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB SaaS OSDU (EUT)"},{"url":"https://eu7.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (MDE)"},{"url":"https://us5.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (PSC)"},{"url":"https://us7.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (USC)"},{"url":"https://us8.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (WUS)"},{"url":"https://as6.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (SAS)"},{"url":"https://eu8.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (SWC)"},{"url":"https://as7.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (MYW)"},{"url":"https://za1.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (ZAN)"},{"url":"/_mock/solutions/core-service/apis/osdu-schema-service","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"authority","in":"query","required":false,"example":"osdu","schemaId":"schema_1"},{"name":"source","in":"query","required":false,"example":"wks","schemaId":"schema_2"},{"name":"entityType","in":"query","required":false,"example":"wellbore","schemaId":"schema_3"},{"name":"schemaVersionMajor","in":"query","required":false,"schemaId":"schema_0"},{"name":"schemaVersionMinor","in":"query","required":false,"schemaId":"schema_0"},{"name":"schemaVersionPatch","in":"query","required":false,"schemaId":"schema_0"},{"name":"status","in":"query","schemaId":"schema_4"},{"name":"scope","in":"query","schemaId":"schema_5"},{"name":"latestVersion","in":"query","required":false,"example":true,"schemaId":"schema_6"},{"name":"limit","in":"query","example":10,"schemaId":"schema_7"},{"name":"offset","in":"query","example":0,"schemaId":"schema_8"}],"querystring":[],"header":[{"name":"data-partition-id","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403"],"pointer":"/schema","href":"schema/searchschemainforepository","openApiOperationId":"searchSchemaInfoRepository","summary":"Get identity information for all available schema"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://as5.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (SGP)"},{"url":"https://br5.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB SaaS OSDU (BRS)"},{"url":"https://eu5.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (WEU)"},{"url":"https://eu6.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB SaaS OSDU (EUT)"},{"url":"https://eu7.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (MDE)"},{"url":"https://us5.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (PSC)"},{"url":"https://us7.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (USC)"},{"url":"https://us8.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (WUS)"},{"url":"https://as6.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (SAS)"},{"url":"https://eu8.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (SWC)"},{"url":"https://as7.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (MYW)"},{"url":"https://za1.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (ZAN)"},{"url":"/_mock/solutions/core-service/apis/osdu-schema-service","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SchemaInfoResponse"}},"schemaId":"components/schemas/SchemaInfoResponse"},{"code":"400","description":"Bad user input. Mandatory fields missing or unacceptable value passed to API","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseFormat"}},"schemaId":"components/schemas/ErrorResponseFormat"},{"code":"401","description":"Unknown or invalid user.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseFormat"}},"schemaId":"components/schemas/ErrorResponseFormat"},{"code":"403","description":"User not authorised to access the API","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseFormat"}},"schemaId":"components/schemas/ErrorResponseFormat"}],"pointer":"/paths/~1schema/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SchemaInfoResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SchemaInfoResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponseFormat","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseFormat"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseFormat","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseFormat"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseFormat","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseFormat"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/schema/searchschemainforepository"}],"panels":[]}]},"httpPath":"/schema"},{"label":"Gets schema from the schema repository.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/core-service/apis/osdu-schema-service/schema/get schema","routeSlug":"/solutions/core-service/apis/osdu-schema-service/schema/get schema","metadata":{"seo":{"title":"Gets schema from the schema repository.","description":"Retrieve a schema using its system defined id. Required roles 'users.datalake.viewers' or 'users.datalake.editors' or 'users.datalake.admins' groups to get the schema."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Schema","name":"Gets schema from the schema repository.","deprecated":false,"isWebhook":false,"pointer":"/paths/~1schema~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets schema from the schema repository.","isWebhook":false,"deprecated":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a schema using its system defined id. Required roles 'users.datalake.viewers' or 'users.datalake.editors' or 'users.datalake.admins' groups to get the schema."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"User Token from SLB Authenticator Service"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","description":"the system id of the schema","required":true,"example":"osdu:wks:wellbore:1.0.0"}],"pointer":"/paths/~1schema~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"data-partition-id","in":"header","schemaId":"schema_0","description":"desired data partition id","required":true}],"pointer":"/paths/~1schema~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/schema/{id}","servers":[{"url":"https://as5.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (SGP)"},{"url":"https://br5.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB SaaS OSDU (BRS)"},{"url":"https://eu5.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (WEU)"},{"url":"https://eu6.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB SaaS OSDU (EUT)"},{"url":"https://eu7.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (MDE)"},{"url":"https://us5.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (PSC)"},{"url":"https://us7.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (USC)"},{"url":"https://us8.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (WUS)"},{"url":"https://as6.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (SAS)"},{"url":"https://eu8.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (SWC)"},{"url":"https://as7.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (MYW)"},{"url":"https://za1.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (ZAN)"},{"url":"/_mock/solutions/core-service/apis/osdu-schema-service","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"osdu:wks:wellbore:1.0.0","schemaId":"schema_0"}],"query":[],"querystring":[],"header":[{"name":"data-partition-id","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/schema/{id}","href":"schema/get schema","openApiOperationId":"Get Schema","summary":"Gets schema from the schema repository."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://as5.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (SGP)"},{"url":"https://br5.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB SaaS OSDU (BRS)"},{"url":"https://eu5.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (WEU)"},{"url":"https://eu6.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB SaaS OSDU (EUT)"},{"url":"https://eu7.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (MDE)"},{"url":"https://us5.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (PSC)"},{"url":"https://us7.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (USC)"},{"url":"https://us8.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (WUS)"},{"url":"https://as6.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (SAS)"},{"url":"https://eu8.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (SWC)"},{"url":"https://as7.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (MYW)"},{"url":"https://za1.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (ZAN)"},{"url":"/_mock/solutions/core-service/apis/osdu-schema-service","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"search results matching criteria","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_9","exampleIds":["paths/~1schema~1{id}/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_9","exampleIds":["paths/~1schema~1{id}/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad user input. Mandatory fields missing or unacceptable value passed to API","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseFormat"}},"schemaId":"components/schemas/ErrorResponseFormat"},{"code":"401","description":"Unknown or invalid user.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseFormat"}},"schemaId":"components/schemas/ErrorResponseFormat"},{"code":"403","description":"User not authorised to access the API","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseFormat"}},"schemaId":"components/schemas/ErrorResponseFormat"},{"code":"404","description":"Requested Schema not found in repository","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseFormat"}},"schemaId":"components/schemas/ErrorResponseFormat"}],"pointer":"/paths/~1schema~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_9","exampleIds":["paths/~1schema~1{id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_9","exampleIds":["paths/~1schema~1{id}/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ErrorResponseFormat","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseFormat"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseFormat","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseFormat"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseFormat","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseFormat"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseFormat","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseFormat"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/schema/get schema"}],"panels":[]}]},"httpPath":"/schema/{id}"}],"content":{"contentType":"group","meta":{"name":"Schema"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Schema","showPageActions":true},{"nodeType":"markdoc","content":"Core Schema Service related methods"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/schema","summary":"Adds a schema to the schema repository with status INTERNAL.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/schema/create schema","deprecated":false},{"title":"/schema","summary":"Updates/Creates a schema in DEVELOPMENT status with INTERNAL scope","prefix":{"name":"put","color":"put"},"badges":[],"link":"/schema/update schema","deprecated":false},{"title":"/schema","summary":"Get identity information for all available schema","prefix":{"name":"get","color":"get"},"badges":[],"link":"/schema/searchschemainforepository","deprecated":false},{"title":"/schema/{id}","summary":"Gets schema from the schema repository.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/schema/get schema","deprecated":false}]}]}]}]}},{"type":"group","label":"Shared Schema","link":"/solutions/core-service/apis/osdu-schema-service/shared-schema","routeSlug":"/solutions/core-service/apis/osdu-schema-service/shared-schema","items":[{"label":"Creates/Updates a SHARED schema in development status","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/core-service/apis/osdu-schema-service/shared-schema/update system schema","routeSlug":"/solutions/core-service/apis/osdu-schema-service/shared-schema/update system schema","metadata":{"seo":{"title":"Creates/Updates a SHARED schema in development status","description":"This endpoint allows user to a create schema with all possible states i.e. DEVELOPMENT,PUBLISHED or OBSOLETE but update can be used only on schemas that are in \"DEVELOPMENT\" state. A schema status can also be changed from DEVELOPMENT to PUBLISHED or OBSOLETE while updating schema content or by providing the same schema content.  Note: The schema may refer to other schema definitions in DEVELOPMENT state. If those schemas are updated, it is the schema owner's responsibility to PUT the dependent schemas again in order to refresh the schema definitions. By default scope for a schema created through this endpoint will be SHARED. Service principal authorization is required to call thi API. There is no need to provide a data-partition-id in the header."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update System Schema","name":"Creates/Updates a SHARED schema in development status","deprecated":false,"isWebhook":false,"pointer":"/paths/~1schemas~1system/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates/Updates a SHARED schema in development status","isWebhook":false,"deprecated":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint allows user to a create schema with all possible states i.e. DEVELOPMENT,PUBLISHED or OBSOLETE but update can be used only on schemas that are in \"DEVELOPMENT\" state. A schema status can also be changed from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DEVELOPMENT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PUBLISHED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OBSOLETE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" while updating schema content or by providing the same schema content. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The schema may refer to other schema definitions in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DEVELOPMENT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state. If those schemas are updated, it is the schema owner's responsibility to PUT the dependent schemas again in order to refresh the schema definitions. By default scope for a schema created through this endpoint will be SHARED. Service principal authorization is required to call thi API. There is no need to provide a data-partition-id in the header."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"User Token from SLB Authenticator Service"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SchemaRequest"}},"schemaId":"components/schemas/SchemaRequest","pointer":"/paths/~1schemas~1system/put/requestBody","description":"SchemaRequest"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/schemas/system","servers":[{"url":"https://as5.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (SGP)"},{"url":"https://br5.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB SaaS OSDU (BRS)"},{"url":"https://eu5.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (WEU)"},{"url":"https://eu6.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB SaaS OSDU (EUT)"},{"url":"https://eu7.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (MDE)"},{"url":"https://us5.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (PSC)"},{"url":"https://us7.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (USC)"},{"url":"https://us8.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (WUS)"},{"url":"https://as6.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (SAS)"},{"url":"https://eu8.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (SWC)"},{"url":"https://as7.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (MYW)"},{"url":"https://za1.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (ZAN)"},{"url":"/_mock/solutions/core-service/apis/osdu-schema-service","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SchemaRequest"}},"responseCodes":["200","201","400","401","403"],"pointer":"/schemas/system","href":"shared-schema/update system schema","openApiOperationId":"Update System Schema","summary":"Creates/Updates a SHARED schema in development status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://as5.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (SGP)"},{"url":"https://br5.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB SaaS OSDU (BRS)"},{"url":"https://eu5.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (WEU)"},{"url":"https://eu6.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB SaaS OSDU (EUT)"},{"url":"https://eu7.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (MDE)"},{"url":"https://us5.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (PSC)"},{"url":"https://us7.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (USC)"},{"url":"https://us8.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (WUS)"},{"url":"https://as6.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (SAS)"},{"url":"https://eu8.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (SWC)"},{"url":"https://as7.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (MYW)"},{"url":"https://za1.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (ZAN)"},{"url":"/_mock/solutions/core-service/apis/osdu-schema-service","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/SchemaRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SchemaRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Schema updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SchemaInfo"}},"schemaId":"components/schemas/SchemaInfo"},{"code":"201","description":"Schema created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SchemaInfo"}},"schemaId":"components/schemas/SchemaInfo"},{"code":"400","description":"Bad user input. Mandatory fields missing or unacceptable value passed to API","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseFormat"}},"schemaId":"components/schemas/ErrorResponseFormat"},{"code":"401","description":"Unknown or invalid user.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseFormat"}},"schemaId":"components/schemas/ErrorResponseFormat"},{"code":"403","description":"User not authorised to access the API","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseFormat"}},"schemaId":"components/schemas/ErrorResponseFormat"}],"pointer":"/paths/~1schemas~1system/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SchemaInfo","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SchemaInfo"}}},{"code":"201","schemaId":"components/schemas/SchemaInfo","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SchemaInfo"}}},{"code":"400","schemaId":"components/schemas/ErrorResponseFormat","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseFormat"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseFormat","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseFormat"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseFormat","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseFormat"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shared-schema/update system schema"}],"panels":[]}]},"httpPath":"/schemas/system"}],"content":{"contentType":"group","meta":{"name":"Shared Schema"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Shared Schema","showPageActions":true},{"nodeType":"markdoc","content":"Endpoint to create and update shared schemas"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/schemas/system","summary":"Creates/Updates a SHARED schema in development status","prefix":{"name":"put","color":"put"},"badges":[],"link":"/shared-schema/update system schema","deprecated":false}]}]}]}]}},{"type":"group","label":"Info","link":"/solutions/core-service/apis/osdu-schema-service/info","routeSlug":"/solutions/core-service/apis/osdu-schema-service/info","items":[{"label":"Version info","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/core-service/apis/osdu-schema-service/info/version info","routeSlug":"/solutions/core-service/apis/osdu-schema-service/info/version info","metadata":{"seo":{"title":"Version info","description":"For deployment available public /info endpoint,  which provides build and git related information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Version info","name":"Version info","isWebhook":false,"pointer":"/paths/~1info/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Version info","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For deployment available public "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/info"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint,  which provides build and git related information."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"User Token from SLB Authenticator Service"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/info","servers":[{"url":"https://as5.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (SGP)"},{"url":"https://br5.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB SaaS OSDU (BRS)"},{"url":"https://eu5.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (WEU)"},{"url":"https://eu6.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB SaaS OSDU (EUT)"},{"url":"https://eu7.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (MDE)"},{"url":"https://us5.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (PSC)"},{"url":"https://us7.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (USC)"},{"url":"https://us8.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (WUS)"},{"url":"https://as6.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (SAS)"},{"url":"https://eu8.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (SWC)"},{"url":"https://as7.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (MYW)"},{"url":"https://za1.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (ZAN)"},{"url":"/_mock/solutions/core-service/apis/osdu-schema-service","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/info","href":"info/version info","openApiOperationId":"Version info","summary":"Version info"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://as5.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (SGP)"},{"url":"https://br5.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB SaaS OSDU (BRS)"},{"url":"https://eu5.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (WEU)"},{"url":"https://eu6.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB SaaS OSDU (EUT)"},{"url":"https://eu7.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (MDE)"},{"url":"https://us5.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (PSC)"},{"url":"https://us7.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (USC)"},{"url":"https://us8.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (WUS)"},{"url":"https://as6.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (SAS)"},{"url":"https://eu8.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (SWC)"},{"url":"https://as7.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (MYW)"},{"url":"https://za1.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (ZAN)"},{"url":"/_mock/solutions/core-service/apis/osdu-schema-service","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Version info.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VersionInfo"}},"schemaId":"components/schemas/VersionInfo"}],"pointer":"/paths/~1info/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/VersionInfo","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VersionInfo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/info/version info"}],"panels":[]}]},"httpPath":"/info"}],"content":{"contentType":"group","meta":{"name":"Info"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Info","showPageActions":true},{"nodeType":"markdoc","content":"Build and git information"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/info","summary":"Version info","prefix":{"name":"get","color":"get"},"badges":[],"link":"/info/version info","deprecated":false}]}]}]}]}},{"type":"group","label":"Schema Definitions","link":"/solutions/core-service/apis/osdu-schema-service/schema-definitions","routeSlug":"/solutions/core-service/apis/osdu-schema-service/schema-definitions","items":[{"type":"link","label":"Error","link":"/solutions/core-service/apis/osdu-schema-service/schema-definitions/error","routeSlug":"/solutions/core-service/apis/osdu-schema-service/schema-definitions/error","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"Error"},"seo":{"title":"Error"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Error","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/Error"},"children":[]}]}]}},{"type":"link","label":"ErrorModel","link":"/solutions/core-service/apis/osdu-schema-service/schema-definitions/errormodel","routeSlug":"/solutions/core-service/apis/osdu-schema-service/schema-definitions/errormodel","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"ErrorModel"},"seo":{"title":"ErrorModel"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ErrorModel","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/ErrorModel"},"children":[]}]}]}},{"type":"link","label":"ErrorResponseFormat","link":"/solutions/core-service/apis/osdu-schema-service/schema-definitions/errorresponseformat","routeSlug":"/solutions/core-service/apis/osdu-schema-service/schema-definitions/errorresponseformat","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"ErrorResponseFormat"},"seo":{"title":"ErrorResponseFormat"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ErrorResponseFormat","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/ErrorResponseFormat"},"children":[]}]}]}},{"type":"link","label":"SchemaInfo Response","link":"/solutions/core-service/apis/osdu-schema-service/schema-definitions/schemainforesponse","routeSlug":"/solutions/core-service/apis/osdu-schema-service/schema-definitions/schemainforesponse","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"SchemaInfoResponse"},"seo":{"title":"SchemaInfo Response"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"SchemaInfo Response","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/SchemaInfoResponse"},"children":[]}]}]}},{"type":"link","label":"Schema Info","link":"/solutions/core-service/apis/osdu-schema-service/schema-definitions/schemainfo","routeSlug":"/solutions/core-service/apis/osdu-schema-service/schema-definitions/schemainfo","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"SchemaInfo"},"seo":{"title":"Schema Info"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Schema Info","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/SchemaInfo"},"children":[]}]}]}},{"type":"link","label":"SchemaIdentity","link":"/solutions/core-service/apis/osdu-schema-service/schema-definitions/schemaidentity","routeSlug":"/solutions/core-service/apis/osdu-schema-service/schema-definitions/schemaidentity","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"SchemaIdentity"},"seo":{"title":"SchemaIdentity"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"SchemaIdentity","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/SchemaIdentity"},"children":[]}]}]}},{"type":"link","label":"SchemaRequest","link":"/solutions/core-service/apis/osdu-schema-service/schema-definitions/schemarequest","routeSlug":"/solutions/core-service/apis/osdu-schema-service/schema-definitions/schemarequest","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"SchemaRequest"},"seo":{"title":"SchemaRequest"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"SchemaRequest","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/SchemaRequest"},"children":[]}]}]}},{"type":"link","label":"VersionInfo","link":"/solutions/core-service/apis/osdu-schema-service/schema-definitions/versioninfo","routeSlug":"/solutions/core-service/apis/osdu-schema-service/schema-definitions/versioninfo","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"VersionInfo"},"seo":{"title":"VersionInfo"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"VersionInfo","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/VersionInfo"},"children":[]}]}]}},{"type":"link","label":"ConnectedOuterService","link":"/solutions/core-service/apis/osdu-schema-service/schema-definitions/connectedouterservice","routeSlug":"/solutions/core-service/apis/osdu-schema-service/schema-definitions/connectedouterservice","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"ConnectedOuterService"},"seo":{"title":"ConnectedOuterService"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ConnectedOuterService","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/ConnectedOuterService"},"children":[]}]}]}}],"content":{"contentType":"group","meta":{"name":"Schema Definitions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Schema Definitions","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Schemas","titleTranslationKey":"schemas","items":[{"title":"Error","link":"/schema-definitions/error","deprecated":false},{"title":"ErrorModel","link":"/schema-definitions/errormodel","deprecated":false},{"title":"ErrorResponseFormat","link":"/schema-definitions/errorresponseformat","deprecated":false},{"title":"SchemaInfo Response","link":"/schema-definitions/schemainforesponse","deprecated":false},{"title":"Schema Info","link":"/schema-definitions/schemainfo","deprecated":false},{"title":"SchemaIdentity","link":"/schema-definitions/schemaidentity","deprecated":false},{"title":"SchemaRequest","link":"/schema-definitions/schemarequest","deprecated":false},{"title":"VersionInfo","link":"/schema-definitions/versioninfo","deprecated":false},{"title":"ConnectedOuterService","link":"/schema-definitions/connectedouterservice","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/Error":{"id":"components/schemas/Error","kind":"json-schema","title":"Error","data":{"type":"object","properties":{"message":{"type":"string"},"reason":{"type":"string"},"domain":{"type":"string"}}}},"components/schemas/ErrorModel":{"id":"components/schemas/ErrorModel","kind":"json-schema","title":"ErrorModel","data":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"code":{"type":"integer","format":"int32"},"message":{"type":"string"}}}},"components/schemas/ErrorResponseFormat":{"id":"components/schemas/ErrorResponseFormat","kind":"json-schema","title":"ErrorResponseFormat","data":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/ErrorModel"}},"description":"An error that occurs during normal application logic"}},"components/schemas/SchemaInfoResponse":{"id":"components/schemas/SchemaInfoResponse","kind":"json-schema","title":"SchemaInfo Response","data":{"description":"The response for a GET schema request","title":"SchemaInfo Response","properties":{"schemaInfos":{"type":"array","items":{"$ref":"#/components/schemas/SchemaInfo"}},"offset":{"type":"integer","description":"The offset for the next query","title":"Offset","minimum":0},"count":{"type":"integer","description":"The number of schema versions in this response","title":"Count","minimum":0},"totalCount":{"type":"integer","description":"The total number of entity type codes in the repositories","title":"Count","minimum":0}}}},"components/schemas/SchemaInfo":{"id":"components/schemas/SchemaInfo","kind":"json-schema","title":"Schema Info","data":{"type":"object","required":["schemaIdentity","status"],"properties":{"createdBy":{"type":"string","example":"user@opendes.com","description":"The user who created the schema. This value is taken from API caller token."},"dateCreated":{"type":"string","format":"date-time","example":"2019-05-23 11:16:03+00:00","description":"The UTC date time of the entity creation"},"schemaIdentity":{"$ref":"#/components/schemas/SchemaIdentity"},"scope":{"type":"string","example":"INTERNAL","description":"Schema Scope - is it internal or shared. This is a system defined attribute based on partition-id passed.","enum":["INTERNAL","SHARED"]},"status":{"type":"string","description":"Schema lifecycle status","enum":["PUBLISHED","OBSOLETE","DEVELOPMENT"]},"supersededBy":{"$ref":"#/components/schemas/SchemaIdentity"}},"title":"Schema Info","description":"Schema info including status, creation and schemaIdentity"}},"components/schemas/SchemaIdentity":{"id":"components/schemas/SchemaIdentity","kind":"json-schema","title":"SchemaIdentity","data":{"type":"object","required":["authority","entityType","source","schemaVersionMajor","schemaVersionMinor","schemaVersionPatch"],"properties":{"authority":{"type":"string","example":"osdu","description":"Entity authority"},"entityType":{"type":"string","example":"wellbore","description":"EntityType Code"},"id":{"type":"string","example":"osdu:wks:wellbore:1.0.0","description":"A read-only system defined id used for referencing of a schema."},"schemaVersionMajor":{"type":"integer","example":1,"description":"Major Schema Version Number"},"schemaVersionMinor":{"type":"integer","example":1,"description":"Minor Schema Version Number"},"schemaVersionPatch":{"type":"integer","example":0,"description":"Patch Schema Version Number"},"source":{"type":"string","example":"wks","description":"Entity source"}},"title":"SchemaIdentity","description":"Schema authority source and type description"}},"components/schemas/SchemaRequest":{"id":"components/schemas/SchemaRequest","kind":"json-schema","title":"SchemaRequest","data":{"type":"object","required":["schema","schemaInfo"],"properties":{"schema":{"type":"object"},"schemaInfo":{"$ref":"#/components/schemas/SchemaInfo"}},"title":"SchemaRequest","example":{"schemaInfo":{"schemaIdentity":{"authority":"osdu","source":"wks","entityType":"wellbore","schemaVersionMajor":1,"schemaVersionMinor":0,"schemaVersionPatch":0},"status":"DEVELOPMENT"},"schema":{}}}},"components/schemas/VersionInfo":{"id":"components/schemas/VersionInfo","kind":"json-schema","title":"VersionInfo","data":{"type":"object","properties":{"groupId":{"type":"string","description":"Maven artifact group ID."},"actifactId":{"type":"string","description":"Maven artifact ID."},"version":{"type":"string","description":"Maven artifact version"},"buildTime":{"type":"string","description":"Maven artifact build time"},"branch":{"type":"string","description":"Current git branch"},"commitId":{"type":"string","description":"Latest commit hash"},"commitMessage":{"type":"string","description":"Latest commit message"},"connectedOuterServices":{"type":"array","description":"Connected outer services information","items":{"$ref":"#/components/schemas/ConnectedOuterService"}}},"description":"Version info."}},"components/schemas/ConnectedOuterService":{"id":"components/schemas/ConnectedOuterService","kind":"json-schema","title":"ConnectedOuterService","data":{"type":"object","properties":{"name":{"type":"string","description":"Connected outer service name."},"version":{"type":"string","description":"Connected outer service version."}},"description":"Connected outer service information."}},"schema_0":{"kind":"json-schema","data":{"type":"string"},"id":"schema_0"},"schema_1":{"kind":"json-schema","data":{"type":"string","default":"*","example":"osdu"},"id":"schema_1"},"schema_2":{"kind":"json-schema","data":{"type":"string","default":"*","example":"wks"},"id":"schema_2"},"schema_3":{"kind":"json-schema","data":{"type":"string","default":"*","example":"wellbore"},"id":"schema_3"},"schema_4":{"kind":"json-schema","data":{"type":"string","title":"Schema Status","enum":["PUBLISHED","DEVELOPMENT","OBSOLETE"]},"id":"schema_4"},"schema_5":{"kind":"json-schema","data":{"type":"string","title":"Scope","enum":["SHARED","INTERNAL"]},"id":"schema_5"},"schema_6":{"kind":"json-schema","data":{"type":"boolean","default":false,"example":true},"id":"schema_6"},"schema_7":{"kind":"json-schema","data":{"type":"integer","minimum":0,"maximum":100,"example":10},"id":"schema_7"},"schema_8":{"kind":"json-schema","data":{"type":"integer","minimum":0,"example":0},"id":"schema_8"},"schema_9":{"kind":"json-schema","data":{"type":"object"},"id":"schema_9"}},"exampleStore":{"paths/~1schema~1{id}/get/responses/200/content/application~1json/example":{"value":{"$schema":"http://json-schema.org/draft-07/schema#","description":"The entity shapefile.","title":"ShapeFile","type":"object","definitions":{},"properties":{}},"id":"paths/~1schema~1{id}/get/responses/200/content/application~1json/example"}},"securitySchemeStore":{"bearer":{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT","description":"User Token from SLB Authenticator Service"}},"specVersion":"3.0.0","servers":[{"url":"https://as5.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (SGP)"},{"url":"https://br5.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB SaaS OSDU (BRS)"},{"url":"https://eu5.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (WEU)"},{"url":"https://eu6.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB SaaS OSDU (EUT)"},{"url":"https://eu7.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (MDE)"},{"url":"https://us5.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (PSC)"},{"url":"https://us7.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (USC)"},{"url":"https://us8.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (WUS)"},{"url":"https://as6.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (SAS)"},{"url":"https://eu8.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (SWC)"},{"url":"https://as7.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (MYW)"},{"url":"https://za1.api.enterprisedata.slb.com/api/schema-service/v1","description":"SLB Saas OSDU (ZAN)"},{"url":"/_mock/solutions/core-service/apis/osdu-schema-service","isMockServer":true,"description":"Mock server"}],"specType":"openapi"},"options":{"schemaDefinitionsTagName":"Schema Definitions","mockServer":{"url":"/_mock/solutions/core-service/apis/osdu-schema-service","position":"last","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/solutions/core-service/apis/OSDU-Schema-Service.json?download"},{"url":"/_bundle/solutions/core-service/apis/OSDU-Schema-Service.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Schema APIs","description":"Schema Service enables schema management in the Data Platform and offers an\nimplementation of the schema standard.\n\nSchema Service handles schema life cycle to help with the development of schemas in the Ecosystem.\n\n```plain {% title=\"Client ID\" %}\n963f2cc6915e479fa0fcb73ec2ec90e7\n```\n\n## Schema States\n\nThis lifecycle consists of three states - \"DEVELOPMENT\", \"PUBLISHED\" and \"OBSOLETE\".\n\n* `DEVELOPMENT` - Denotes that a Schema is in draft or evolutionary phase. Schema in this state is mutable.\n\n* `PUBLISHED` - A Schema can directly be created in published state or moved from the DEVELOPMENT state to the PUBLISHED state. A Schema in published state is immutable.\n\n* `OBSOLETE` - Schema can be marked as obsolete once they are no more in use. You can change DEVELOPMENT state schemas to OBSOLETE state.\n\n## Schema Scopes\n\n* `INTERNAL` - A schema defined in a certain data partition and accessible to only the users of that data partition is said to have \"INTERNAL\" scope.\n\n* `SHARED` - The Managed Planning Data Foundation makes certain standard schema available out of the box to all OSDU data partitions. These schema will have scope as \"SHARED\" by default and it should be created using system endpoint.\n"}},"baseSlug":"/solutions/core-service/apis/osdu-schema-service","routesMapping":{}}