Skip to content
Snippets Groups Projects
Normal view Permalink
README.md 1.08 KiB
Newer Older
  • Learn to ignore specific revisions
    • David Diederich's avatar
    Initial Import
    David Diederich committed
    1 2 
    # Introduction
    ethiraj krishnamanaidu's avatar
    Updated README  
    ethiraj krishnamanaidu committed
    3 4 
    os-indexer-azure is a [Spring Boot](https://spring.io/projects/spring-boot) service that is responsible for indexing Records that enable the `os-search` service to execute OSDU R2 domain searches against Elasticsearch.
    David Diederich's avatar
    Initial Import
    David Diederich committed
    5 6 7 8 
    ## Azure Implementation

The [os-indexer-azure README.md](./provider/indexer-azure/README.md) has all the information needed to get started
running the `os-indexer` Azure implementation
    Riabokon Stanislav(EPAM)[GCP]'s avatar
    https://jiraeu.epam.com/browse/GONRG-539  
    Riabokon Stanislav(EPAM)[GCP] committed
    9
    Eldor Pulatov [EPAM/GCP]'s avatar
    GONRG-5890-Change-to-GC  
    Eldor Pulatov [EPAM/GCP] committed
    10 
    ## Google Cloud Implementation
    Riabokon Stanislav(EPAM)[GCP]'s avatar
    https://jiraeu.epam.com/browse/GONRG-539  
    Riabokon Stanislav(EPAM)[GCP] committed
    11
    Aliaksandr Ramanovich (EPAM)'s avatar
    GONRG-5894 - gc rename  
    Aliaksandr Ramanovich (EPAM) committed
    12 
    All documentation for the Google Cloud implementation of `os-indexer` lives [here](./provider/indexer-gc/README.md)
    Spencer Sutton's avatar
    Adding AWS ReadMe  
    Spencer Sutton committed
    13 14 15 
    
## AWS Implementation
    Aliaksandr Ramanovich (EPAM)'s avatar
    GONRG-5894 - gc rename  
    Aliaksandr Ramanovich (EPAM) committed
    16 
    All documentation for the AWS implementation of `os-indexer` lives [here](./provider/indexer-aws/README.md)
    Thulasi Dass Subramanian's avatar
    OpenAPI 3.0 Documentation using springdoc  
    Thulasi Dass Subramanian committed
    17 18 19 20 21 22 23 
    
## 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](./indexer-core/src/main/resources/swagger.properties)