Copyright 2017-2020, Schlumberger

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

 http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Register service

The Register Service is a Maven multi-module project with each cloud implementation placed in its submodule.

Documentation

Official documentation is located at https://osdu.pages.opengroup.org/platform/system/register/

Google Cloud

Instructions for running the Google Cloud implementation locally can be found here.

Running integration tests

See Integration-Testing Readme.

Open API 3.0 - Swagger

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

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

Server Url(full path vs relative path) configuration

• api.server.fullUrl.enabled=true It will generate full server url in the OpenAPI swagger
• api.server.fullUrl.enabled=false It will generate only the contextPath only
• default value is false (Currently only in Azure it is enabled) [Reference]:(https://springdoc.org/faq.html#_how_is_server_url_generated)

Updated github url test2

AWS

Instructions for running and testing this service can be found here