|
|
Specifications for OpenDES APIs
|
|
|
|
|
|
[[_TOC_]]
|
|
|
|
|
|
|
|
|
# Core APIs
|
|
|
| Service | Swagger 2.0 | Pretty Version | Tutorial |
|
|
|
|------------------------------|:--------------------------------------------------------------------------------------------------------:|:----------------------------------------------------------------------------------------------------------:|:----------------------------------------------------------------------------------------------------------------------------------------------:|
|
|
|
| Compliance Service | [API](/OSDU-\(C\)/Design-and-Implementation/API-Specifications/Swagger-2.0/Compliance-Service) | [Markdown](/OSDU-\(C\)/Design-and-Implementation/API-Specifications/Markdown/Compliance-Service) | [Documentation](/OSDU-\(C\)/Design-and-Implementation/API-Specifications/Documentation/core-services/ComplianceService) |
|
|
|
| CRS Catalog Service | [API](/OSDU-\(C\)/Design-and-Implementation/API-Specifications/Swagger-2.0/CRS-Catalog-Service) | [Markdown](/OSDU-\(C\)/Design-and-Implementation/API-Specifications/Markdown/CRS-Catalog-Service) | [Documentation](/OSDU-\(C\)/Design-and-Implementation/API-Specifications/Documentation/core-services/CRSCatalogService) |
|
|
|
| CRS Conversion Service | [API](/OSDU-\(C\)/Design-and-Implementation/API-Specifications/Swagger-2.0/CRS-Conversion-Service) | [Markdown](/OSDU-\(C\)/Design-and-Implementation/API-Specifications/Markdown/CRS-Converter-Service) | [Documentation](/OSDU-\(C\)/Design-and-Implementation/API-Specifications/Documentation/core-services/CRSConversionService) |
|
|
|
| Entitlements Service | [API](/OSDU-\(C\)/Design-and-Implementation/API-Specifications/Swagger-2.0/Entitlements-Service) | [Markdown](/OSDU-\(C\)/Design-and-Implementation/API-Specifications/Markdown/Entitlements-Service) | [Documentation](/OSDU-\(C\)/Design-and-Implementation/API-Specifications/Documentation/core-services/EntitlementsService) |
|
|
|
| Frame of Reference | | | [Documentation](/OSDU-\(C\)/Design-and-Implementation/API-Specifications/Documentation/core-services/FrameOfReference) |
|
|
|
| Get File Service | [API](/OSDU-\(C\)/Design-and-Implementation/API-Specifications/Swagger-2.0/Get-File-Service) | [Markdown](/OSDU-\(C\)/Design-and-Implementation/API-Specifications/Markdown/Get-File-Service) | |
|
|
|
| Indexer Service | | | [Documentation](/OSDU-\(C\)/Design-and-Implementation/API-Specifications/Documentation/core-services/IndexerService) |
|
|
|
|Schema Service|[API](/OSDU-\(C\)/Design-and-Implementation/API-Specifications/Swagger-2.0/Schema-Service)|[Markdown](/OSDU-\(C\)/Design-and-Implementation/API-Specifications/Markdown/Schema-Service)| - in development
|
|
|
| Search Service | [API](/OSDU-\(C\)/Design-and-Implementation/API-Specifications/Swagger-2.0/Search-Service) | [Markdown](/OSDU-\(C\)/Design-and-Implementation/API-Specifications/Markdown/Search-Service) | [Documentation](/OSDU-\(C\)/Design-and-Implementation/API-Specifications/Documentation/core-services/SearchService) |
|
|
|
| Storage Service | [API](/OSDU-\(C\)/Design-and-Implementation/API-Specifications/Swagger-2.0/Storage-Service) | [Markdown](/OSDU-\(C\)/Design-and-Implementation/API-Specifications/Markdown/Storage-Service) | [Documentation](/OSDU-\(C\)/Design-and-Implementation/API-Specifications/Documentation/core-services/StorageService) |
|
|
|
| Spatial Reference Service | [API](/OSDU-\(C\)/Design-and-Implementation/API-Specifications/Swagger-2.0/Spatial-Reference) | [Markdown](/OSDU-\(C\)/Design-and-Implementation/API-Specifications/Markdown/Spatial-Reference) | [Documentation](/OSDU-\(C\)/Design-and-Implementation/API-Specifications/Documentation/core-services/SpatialRefService) |
|
|
|
| Unit Service | [API](/OSDU-\(C\)/Design-and-Implementation/API-Specifications/Swagger-2.0/Unit-Service) | [Markdown](/OSDU-\(C\)/Design-and-Implementation/API-Specifications/Markdown/Unit-Service) | [Documentation](/OSDU-\(C\)/Design-and-Implementation/API-Specifications/Documentation/core-services/UnitService) |
|
|
|
|
|
|
# Ingestion APIs
|
|
|
| Service | Swagger 2.0 | Pretty Version | Tutorial |
|
|
|
|------------------------------|:--------------------------------------------------------------------------------------------------------:|:----------------------------------------------------------------------------------------------------------:|:----------------------------------------------------------------------------------------------------------------------------------------------:|
|
|
|
|Data Catalog Service |[API](/OSDU-\(C\)/Design-and-Implementation/API-Specifications/Swagger-2.0/Data-Catalog-Service)|[Markdown](/OSDU-\(C\)/Design-and-Implementation/API-Specifications/Markdown/Data-Catalog-Service)|[Documentation](/OSDU-\(C\)/Design-and-Implementation/API-Specifications/Documentation/ingestion-services/DataCatalogService)
|
|
|
| Ingestion Service | [API](/OSDU-\(C\)/Design-and-Implementation/API-Specifications/Swagger-2.0/Ingestion-Pipeline-Service) | [Markdown](/OSDU-\(C\)/Design-and-Implementation/API-Specifications/Markdown/Ingestion-Pipeline-Service) | [Documentation](/OSDU-\(C\)/Design-and-Implementation/API-Specifications/Documentation/ingestion-services/IngestionService) |
|
|
|
|
|
|
# Enrichment and Consumption APIs
|
|
|
| Service | Swagger 2.0 | Pretty Version | Tutorial |
|
|
|
|------------------------------|:--------------------------------------------------------------------------------------------------------:|:----------------------------------------------------------------------------------------------------------:|:----------------------------------------------------------------------------------------------------------------------------------------------:|
|
|
|
| Document Query Service | [API](/OSDU-\(C\)/Design-and-Implementation/API-Specifications/Swagger-2.0/Document-Query-Service) | [Markdown](/OSDU-\(C\)/Design-and-Implementation/API-Specifications/Markdown/Document-Query-Service) | [Documentation](/OSDU-\(C\)/Design-and-Implementation/API-Specifications/Documentation/consumption-services/DocumentQueryService) |
|
|
|
| Document indexing service | [API](/OSDU-\(C\)/Design-and-Implementation/API-Specifications/Swagger-2.0/Document-indexing-service) | [Markdown](/OSDU-\(C\)/Design-and-Implementation/API-Specifications/Markdown/Document-Indexing-Service) | [Documentation](/OSDU-\(C\)/Design-and-Implementation/API-Specifications/Documentation/consumption-services/DocumentIndexingService) |
|
|
|
| Enrichment Attribute Catalog | [API](/OSDU-\(C\)/Design-and-Implementation/API-Specifications/Swagger-2.0/Enrichment-Attribute-Catalog) | [Markdown](/OSDU-\(C\)/Design-and-Implementation/API-Specifications/Markdown/Enrichment-Attribute-Catalog) | [Documentation](/OSDU-\(C\)/Design-and-Implementation/API-Specifications/Documentation/consumption-services/EnrichmentAttributeCatalogService) |
|
|
|
| Enrichment Fetch Service | [API](/OSDU-\(C\)/Design-and-Implementation/API-Specifications/Swagger-2.0/Enrichment-Fetch-Service) | [Markdown](/OSDU-\(C\)/Design-and-Implementation/API-Specifications/Markdown/Enrichment-Fetch-Service) | [Documentation](/OSDU-\(C\)/Design-and-Implementation/API-Specifications/Documentation/consumption-services/EnrichmentFetchService)
|
|
|
|
|
|
# Domain APIs
|
|
|
| Service | Swagger 2.0 | Pretty Version | Tutorial |
|
|
|
|------------------------------|:--------------------------------------------------------------------------------------------------------:|:----------------------------------------------------------------------------------------------------------:|:----------------------------------------------------------------------------------------------------------------------------------------------:|
|
|
|
|Log Store Service|[API](/OSDU-\(C\)/Design-and-Implementation/API-Specifications/Swagger-2.0/LogStore)||
|
|
|
|
|
|
# Internal APIs
|
|
|
| Service | Swagger 2.0 | Pretty Version | Tutorial |
|
|
|
|------------------------------|:--------------------------------------------------------------------------------------------------------:|:----------------------------------------------------------------------------------------------------------:|:----------------------------------------------------------------------------------------------------------------------------------------------:|
|
|
|
Plugin Manager Service | [API](/OSDU-\(C\)/Design-and-Implementation/API-Specifications/Swagger-2.0/Manager-Service)|[Markdown](/OSDU-\(C\)/Design-and-Implementation/API-Specifications/Markdown/Manager-Service)| Private
|
|
|
Messaging Service|[API](/OSDU-\(C\)/Design-and-Implementation/API-Specifications/Swagger-2.0/Messaging-Service)|[Markdown](/OSDU-\(C\)/Design-and-Implementation/API-Specifications/Markdown/Messaging-Service)| Private
|
|
|
|
|
|
|