Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Swagger-specifications for geography #976

Open
wants to merge 7 commits into
base: develop
Choose a base branch
from

Conversation

mrsimpson
Copy link

@mrsimpson mrsimpson commented Apr 1, 2022

📚 Purpose

This PR includes swagger definitions for the geography API.
Actually, this could/should be part of the OMF spec repo, but as the version in mds core is not the most current one and e. g. there cannot be a commit to the 1.0-branch of the spec in the past, I'll focus on adding it here

👌 Includes (WIP state):

/geographies

  • schema definitions
  • operation definitions
  • examples
  • Mock service

Remark: In order to make this PR merge-able earlier, I removed the policy-related API from this PR. I'll create another one for that purpose

@changeset-bot
Copy link

changeset-bot bot commented Apr 1, 2022

⚠️ No Changeset found

Latest commit: 71db375

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@mrsimpson
Copy link
Author

@avatarneil wdyt? Does that help (without using it for schema generation or validation within the api-service)

@avatarneil
Copy link

@mrsimpson this looks great! I think even though this isn't using any of the schema generation or anything, it's still useful from a documentation perspective.

@avatarneil avatarneil marked this pull request as draft April 4, 2022 18:46
@mrsimpson mrsimpson changed the title WIP: Swagger-specifications for geography and policy Swagger-specifications for geography Apr 9, 2022
@mrsimpson mrsimpson marked this pull request as ready for review April 9, 2022 21:23
@mrsimpson
Copy link
Author

@avatarneil I reduced this PR to /geography. I got sidetracked by other stuff and will not be able to complete the policy part in the next days.
Therefore, feel free to merge this not holistic but imho consistent PR

comma matters
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.

None yet

2 participants