1750: Endpoint specification for verein360 #1773
Merged
Conversation
This file contains 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
ztefanie
requested review from
steffenkleinle,
f1sh1918 and
seluianova
as code owners
ztefanie
changed the base branch from
main
to
1623-add-i18n-for-administration
ztefanie
commented
Nov 14, 2024
ztefanie
changed the title
docs/verein360-enpoint.md
Outdated
| "organization": { | ||
| "address": { | ||
| "country": { | ||
| "shortText": "Germany" |
There was a problem hiding this comment.
❓ Why are these shortText attributes needed?
Not sure about this one:
Suggested change
| "shortText": "Germany" | |
| "shortText": "Deutschland" |
There was a problem hiding this comment.
if you send an application you can check the actual payload. But good question why this was implemented like this, maybe @michael-markl can give some input
f1sh1918
approved these changes
Nov 18, 2024
There was a problem hiding this comment.
For me this looks good. Just checked the payload.
Two minor things:
- We should clarify how we get the "source" of application. But as i commented this can also be applied via the api token. I think thats better than provide here an optional string field.
- I would just add some comments to the dates (format : yyyy-mm-dd f.e.)
docs/verein360-enpoint.md
Outdated
| "organization": { | ||
| "address": { | ||
| "country": { | ||
| "shortText": "Germany" |
There was a problem hiding this comment.
if you send an application you can check the actual payload. But good question why this was implemented like this, maybe @michael-markl can give some input
steffenkleinle
approved these changes
Nov 20, 2024
| @@ -7,9 +7,9 @@ All details about the endpoint can be found in the [API Documentation](../specs/ | |||
|
|
|||
| ## Usage | |||
|
|
|||
| ### Set Authourization Header | |||
| ### Authourization Header | |||
There was a problem hiding this comment.
🙃 Typo
Suggested change
| ### Authourization Header | |
| ### Authorization Header |
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.
Short description
Added documentation we can sent to verein360. As soon as this PR is approved I will send this documentation to Verein360. The deadline for this is end of november.
Testing
you can call the endpoint as specified and check if this works as expected.
Resolved issues
Fixes: #1750