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.

Sign up for GitHub

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

Jump to bottom

Extend info on timeout parameter #73

Merged
merged 17 commits into from
Dec 15, 2020
Merged

Extend info on timeout parameter #73

merged 17 commits into from
Dec 15, 2020

Conversation

bonaparten
Copy link
Contributor

@bonaparten bonaparten commented Nov 10, 2020 •
edited by tyrasd
Loading

Resolves #66

@bonaparten bonaparten linked an issue Nov 10, 2020 that may be closed by this pull request
Extend description of timeout parameter #66
Closed
@bonaparten bonaparten changed the title Docs: Update description of the timeout parameter. Resolves: #66 WIP: Update description of the timeout parameter. Resolves: #66 Nov 10, 2020
FabiKo117
FabiKo117 suggested changes Nov 10, 2020
View reviewed changes
Copy link
Contributor

@FabiKo117 FabiKo117 left a comment

Choose a reason for hiding this comment

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

The change of the description seems good, but the /metadata request does not return the mentioned information yet :)
This still needs to be implemented as well in this PR.

@tyrasd tyrasd added the documentation Improvements or additions to documentation label Nov 17, 2020
FabiKo117
FabiKo117 suggested changes Nov 25, 2020
View reviewed changes
Copy link
Contributor

@FabiKo117 FabiKo117 left a comment

Choose a reason for hiding this comment

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

see inline comment

src/main/java/org/heigit/ohsome/ohsomeapi/oshdb/ExtractMetadata.java Outdated Show resolved Hide resolved
@FabiKo117 FabiKo117 added this to the 1.3 milestone Nov 25, 2020
@bonaparten bonaparten force-pushed the extend-description-timeout-parameter branch from 25d2d1b to 54281b4 Compare November 25, 2020 09:58
@tyrasd tyrasd requested a review from FabiKo117 November 25, 2020 15:16
FabiKo117
FabiKo117 suggested changes Nov 25, 2020
View reviewed changes
Copy link
Contributor

@FabiKo117 FabiKo117 left a comment

Choose a reason for hiding this comment

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

see #73 (comment)

@bonaparten bonaparten force-pushed the extend-description-timeout-parameter branch from c6c96b3 to b6471eb Compare December 3, 2020 13:41
@FabiKo117 FabiKo117 changed the title WIP: Update description of the timeout parameter. Resolves: #66 Extending info on timeout parameter Resolves: #66 Dec 10, 2020
Rosario Trischitta and others added 12 commits December 15, 2020 09:29
@FabiKo117
Docs: Update description of the timeout parameter. Resolves: #66
2f13b0f
@FabiKo117
chore: add timeout parameter in metadata request
406198e
@FabiKo117
style: change description of the timeout parameter in swagger
6b668b3
@FabiKo117
chore: set timeout default value dependent on server settings
9bf361b
@FabiKo117
style: change variable name
361e3b1
@FabiKo117
style: chage variable name to timeoutInSeconds
2060df8
@FabiKo117
docs: add description of metadata response params
1be054e
@FabiKo117
style: change variable name
9d9d844
@FabiKo117
docs: add timeout parameter
d63a037 
add timeout parameter in the metadata response
@FabiKo117
changing timeout example value in docs
f9adb72 
to represent the current timeout value of the running instance
@FabiKo117
modifying metadata response descriptions
6b51241 
shortening, combining info and changing info on replicationSequenceNumber
@FabiKo117
extending test on /metadata endpoint
36f9b48 
adding test case for new timeout response parameter
adding other test cases on existing response parameters
@FabiKo117
modifying metadata test
d793564 
checking on defined timeout in ProcessingData
@FabiKo117 FabiKo117 force-pushed the extend-description-timeout-parameter branch from 804180a to d793564 Compare December 15, 2020 08:30
@FabiKo117 FabiKo117 requested a review from tyrasd December 15, 2020 08:30
tyrasd
tyrasd requested changes Dec 15, 2020
View reviewed changes
Copy link
Member

@tyrasd tyrasd left a comment

Choose a reason for hiding this comment

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

I found a few typos and some places where the documentation could be improved. See the inline comments and suggested changes.

docs/endpoints.rst Outdated Show resolved Hide resolved
docs/response-parameters.rst Outdated Show resolved Hide resolved
docs/response-parameters.rst Show resolved Hide resolved
docs/response-parameters.rst Outdated Show resolved Hide resolved
src/main/java/org/heigit/ohsome/ohsomeapi/output/metadataresponse/MetadataResponse.java Outdated Show resolved Hide resolved
docs/response-parameters.rst Outdated Show resolved Hide resolved
docs/response-parameters.rst Outdated Show resolved Hide resolved
docs/response-parameters.rst Outdated Show resolved Hide resolved
docs/response-parameters.rst Outdated Show resolved Hide resolved
docs/response-parameters.rst Outdated Show resolved Hide resolved
@tyrasd tyrasd changed the title Extending info on timeout parameter Resolves: #66 Extend info on timeout parameter Dec 15, 2020
@FabiKo117 @tyrasd
Apply suggestions from code review
82aa4f9 
fixing typos and wording
adding additional context to some docs

Co-authored-by: Martin Raifer <[email protected]>
FabiKo117 and others added 2 commits December 15, 2020 11:48
@FabiKo117 @tyrasd
modify wording in swagger-notes
d22c3d6 
of the field apiVersion to be more precise

Co-authored-by: Martin Raifer <[email protected]>
@FabiKo117
modify wording in docs
37ffe19 
for temporalExtent description
@FabiKo117 FabiKo117 merged commit 46cfb0f into master Dec 15, 2020
@FabiKo117 FabiKo117 deleted the extend-description-timeout-parameter branch December 15, 2020 11:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@FabiKo117 FabiKo117 FabiKo117 approved these changes

@tyrasd tyrasd tyrasd approved these changes

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
1.3
Development

Successfully merging this pull request may close these issues.

Extend description of timeout parameter
3 participants
@bonaparten @tyrasd @FabiKo117