Skip to content

SDAP-490 - expanding openapi spec#281

Closed
kevinmarlis wants to merge 4 commits into
apache:developfrom
kevinmarlis:api_spec
Closed

SDAP-490 - expanding openapi spec#281
kevinmarlis wants to merge 4 commits into
apache:developfrom
kevinmarlis:api_spec

Conversation

@kevinmarlis
Copy link
Copy Markdown
Contributor

openapi.yml expanded to include additional commonly used algorithms:

  • dailydifferenceaverage_spark
  • datainbounds
  • latitudeTimeHofMoellerSpark
  • longitudeTimeHofMoellerSpark
  • maxMinMapSpark
  • timeAvgMapSpark
  • timeSeriesSpark
  • varianceSpark

Additional modifications:

  • Added a data mapping section for the algorithms that return spatial data: /timeAvgMapSpark, /maxMinMapSpark, /varianceSpark.
  • Added a general SparkMeta schema that is commonly used by many of these algorithms.

NOTE: Going through the algorithms revealed a lack of parameter naming conventions. Consistency among the algorithms would be nice, but changes could have larger implications downstream ie: frontend tools. This PR doesn't address this.

@kevinmarlis
Copy link
Copy Markdown
Contributor Author

Some quick additional things I just thought of:

  • Should we make a Utility section that could include the version and job endpoints? I didn't include endpoints like capabilities, list, heartbeat, etc. Do we want to include them? They could go in the Utility section
  • The job endpoints don't have responses in the spec...should they?

@kevinmarlis kevinmarlis changed the base branch from master to develop May 1, 2024 23:33
@kevinmarlis kevinmarlis mentioned this pull request May 20, 2024
@kevinmarlis
Copy link
Copy Markdown
Contributor Author

Closing in favor of #310

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant