Skip to content

Initial proposal for Device Swap API#13

Merged
bigludo7 merged 5 commits intomainfrom
jgarciahospital-patch-1
Sep 27, 2024
Merged

Initial proposal for Device Swap API#13
bigludo7 merged 5 commits intomainfrom
jgarciahospital-patch-1

Conversation

@jgarciahospital
Copy link
Contributor

What type of PR is this?

Add one of the following kinds:

  • enhancement/feature
  • documentation

What this PR does / why we need it:

First API proposal, including both endpoint functionality as part of the same API yaml.

Documentation will need to also include detailed description for the kind of scenarios where a Device Swap is considered, per #11 discussion.

Which issue(s) this PR fixes:

Fixes #6

First API proposal, including both endpoint functionality as part of the same API yaml
Copy link
Collaborator

@bigludo7 bigludo7 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks
Look globally good for me. Just a small request to add 422 for alignement with other API.

Copy link
Collaborator

@bigludo7 bigludo7 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Strange - I've a parser error on my favorite swagger ui for lines 62-63 :(

Should be:

  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  version: wip
  x-camara-commonalities: 0.4.0

@jgarciahospital
Copy link
Contributor Author

Strange - I've a parser error on my favorite swagger ui for lines 62-63 :(

Should be:

  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  version: wip
  x-camara-commonalities: 0.4.0

Solved... indentation typo

Copy link
Collaborator

@bigludo7 bigludo7 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@jgarciahospital
Copy link
Contributor Author

Thanks ludovic for the review!

Should we merge and continue the discussion, in another PR, about the API description (as in #11)?

@bigludo7
Copy link
Collaborator

Let keep this week for @krishvenkatachalam to provide feedback?
If not feedback we merge it Friday by EOB

Does it work for you Jorge?

@bigludo7 bigludo7 merged commit a4299ed into main Sep 27, 2024
@hdamker hdamker deleted the jgarciahospital-patch-1 branch July 25, 2025 05:54
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.

Discuss API Design

2 participants