Add Minimal Openapi Specification #12
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
m-linner-ericsson
changed the title
magnusbaeck
reviewed
Aug 11, 2021
zburswa
reviewed
Aug 12, 2021
zburswa
reviewed
Aug 12, 2021
zburswa
reviewed
Aug 12, 2021
zburswa
reviewed
Aug 12, 2021
zburswa
reviewed
Aug 12, 2021
zburswa
reviewed
Aug 12, 2021
magnusbaeck
reviewed
Jul 8, 2022
* GET /events
- Remove parameter pageStartItem
- Remove parameter pageNo
- Remove parameter shallow
- Remove parameter lazy
- Remove parameter readable
- Removed extra slash from examples in explanation texts
- Removed explanation of use of RegExp
- Add explanation of how the example object turns into parameters
- Remove text/html return type
- Add example of returned Eiffel event
- Change text for 400 return
* Remove GET search/{id}
* POST search/{id}
- Remove defaults for limit
- Remove defaults for levels
- Remove parameter tree
- Reword description of request body
- Remove status code 201
- Explain dlt and ult
|
Thanks for all the comments @magnusbaeck! I hope I have now answered them all. |
magnusbaeck
requested changes
Jul 17, 2022
- Limit to one tag - Spelling fixes * GET /events - Drop all type of filter comparators but `=` - Add required for pageSize and totalNumberItems in return value - Adjust total return items to 1 - Use real Eiffel event as an example * GET /event - Use simpler Eiffel event as an example - Make example as a common component * POST /search - Use real Eiffel event as return example
|
@magnusbaeck Thanks again for your comments. Next round 😃 |
magnusbaeck
reviewed
Jul 31, 2022
magnusbaeck
reviewed
Aug 8, 2022
magnusbaeck
requested changes
Nov 3, 2022
t-persson
reviewed
Nov 4, 2022
t-persson
reviewed
Nov 4, 2022
e-backmark-ericsson
suggested changes
Nov 4, 2022
- Improve /events endpoint
- Remove reference to "!" key
- Rewrite "No comparator"
- Improve explanation for multiple query keys
- Improve /search endpoint
- Explain "-1" and add default
- Add missing link types
- Add example of linked upstream/downstream
- Add 400 error code
- Improve language
m-linner-ericsson
requested review from
t-persson,
magnusbaeck and
e-backmark-ericsson
|
Thanks @magnusbaeck for the patience with this! From what i gather we have the following conversation ongoing which should be addressed now:
|
Co-authored-by: Emil Bäckmark <emil.backmark@ericsson.com>
e-backmark-ericsson
approved these changes
Aug 16, 2023
magnusbaeck
reviewed
Sep 14, 2023
Co-authored-by: Magnus Bäck <magnus@noun.se>
|
@magnusbaeck Thanks for you patience with this. I hope we have now sorted out all issues. |
|
From TC meeting Nov 16:
|
t-persson
approved these changes
Jan 18, 2024
e-backmark-ericsson
approved these changes
Jan 18, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Applicable Issues
Action Point from the TC meetings e.g. https://github.com/eiffel-community/community/blob/master/meetings/MEETINGS_TC_2021.md#action-items
Description of the Change
As the ER from Ericsson is not yet open-sourced this API aims as a bridge for those that wish to use the Ericsson ER as a Docker image or use e.g. REMReM and create their own implementation. It is intended as a minimal API that should be supported by event repositories.
The suggested API is based on what REMReM which relies heavily on the ER
/eventsendpoint (see https://github.com/eiffel-community/eiffel-remrem-generate/blob/master/wiki/markdown/usage/service.md#lookups for more information)To see a preview load the API in the Swagger online editor
Alternate Designs
None
Benefits
Describing a minimal API that should be supported by all Event Repositories
Possible Drawbacks
N/A
Sign-off
Developer's Certificate of Origin 1.1
By making a contribution to this project, I certify that:
(a) The contribution was created in whole or in part by me and I
have the right to submit it under the open source license
indicated in the file; or
(b) The contribution is based upon previous work that, to the best
of my knowledge, is covered under an appropriate open source
license and I have the right under that license to submit that
work with modifications, whether created in whole or in part
by me, under the same open source license (unless I am
permitted to submit under a different license), as indicated
in the file; or
(c) The contribution was provided directly to me by some other
person who certified (a), (b) or (c) and I have not modified
it.
(d) I understand and agree that this project and the contribution
are public and that a record of the contribution (including all
personal information I submit with it, including my sign-off) is
maintained indefinitely and may be redistributed consistent with
this project or the open source license(s) involved.
Signed-off-by: Mattias Linnér mattias.linner@ericsson.com