Skip to content

Commit

Permalink
[DMS-247] - Creation of DiscoveryAPI.feature file (#194)
Browse files Browse the repository at this point in the history
  • Loading branch information
elopezgap authored Jul 18, 2024
1 parent b06d2a7 commit d186294
Showing 1 changed file with 71 additions and 0 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
Feature: The Discovery API provides information about the application version, supported data model(s), and URLs for additional metadata.

@ignore
Scenario: 01 GET / returns the root Discovery API document
Given a GET to the root of the API
Then it should respond with 200
And the response body is
"""
{
"version": "1.0.0",
"applicationName": "Ed-Fi Alliance Data Management Service"
"dataModels": [
{
"name": "Ed-Fi",
"version": "5.1.0",
"informationalVersion": "The Ed-Fi Data Standard v5.1"
}
],
"urls": [
"dependencies": "{BASE_URL}/metadata/dependencies",
"openApiMetadata": "{BASE_URL}/metadata/specifications",
"oauth": "{BASE_URL}/oauth/token",
"dataManagementApi": "{BASE_URL}/data",
"xsdMetadata": "{BASE_URL}/metadata/xsd"
]
}
"""

@ignore
Scenario: 02 GET /metadata returns the metadata URL list
Given a GET to "/metadata"
Then it should respond with 200
And the response body is
"""
{
"dependencies": "{BASE_URL}/metadata/dependencies",
"specifications": "{BASE_URL}/metadata/specifications",
"xsdMetadata": "{BASE_URL}/metadata/xsd"
}
"""

@ignore
Scenario: 03 GET /metadata/specifications returns the list of supported API specifications
Given a GET to "/metadata/specifications"
Then it should respond with 200
And the response body is
"""
[
{
"name": "Resources",
"endpointUri": "{BASE_URL}/metadata/specifications/resources-spec.json",
"prefix": ""
},
{
"name": "Descriptors",
"endpointUri": "{BASE_URL}/metadata/specifications/descriptors-spec.json",
"prefix": ""
,
{
"name": "Discovery",
"endpointUri": "{BASE_URL}/metadata/specifications/discovery-spec.json",
"prefix": "Other"
}
]
"""

@ignore
Scenario: 04 GET /metadata/dependencies returns the dependency order for loading documents
Given a GET to "/metadata/dependencies"
Then it should respond with 200
And there is a JSON file in the response body with a list of dependencies

0 comments on commit d186294

Please sign in to comment.