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

Replace usecase "Admin checks server version" with "Admin fetches server runtime data" and provide JSON object #469

Closed
Jeeppler opened this issue Dec 1, 2020 · 3 comments · Fixed by #2518
Closed

Replace usecase "Admin checks server version" with "Admin fetches server runtime data" and provide JSON object #469

Jeeppler opened this issue Dec 1, 2020 · 3 comments · Fixed by #2518
Assignees
@de-jcup @sven-dmlr
Labels
administration api breaking-change enhancement New feature or request
Milestone
Server 1.7.0

Comments

@Jeeppler
Copy link
Member

Jeeppler commented Dec 1, 2020 •
edited
Loading

The admin checks server version API returns a plain text result instead of the usual JSON: https://daimler.github.io/sechub/latest/sechub-restapi.html#admin-checks-server-version

The problem with that is, that OpenAPI cannot figure out the type of the returned payload.

Jeremias Eppler [email protected], Daimler TSS GmbH, imprint
@Jeeppler Jeeppler added enhancement New feature or request api labels Dec 1, 2020
@Jeeppler
Copy link
Member Author

Related #377

Jeeppler added a commit that referenced this issue Aug 28, 2023
@Jeeppler
Replace status page API calls with SecHub Java API calls #2513 and im…
712eca5 
…plement #469

- return JSON instead of text for the server version #469
- adjust the REST Doc tests für #469
- replace the status page API calls with SecHub Java API calls #2513
- improve return value of server status API call #2513

closes: #2513
closes: #469
@Jeeppler Jeeppler mentioned this issue Aug 28, 2023
Merged
4 tasks
Jeeppler added a commit that referenced this issue Oct 4, 2023
@Jeeppler
Return only server version #469
06142bb
@de-jcup
Copy link
Member

de-jcup commented Feb 28, 2024 •
edited by sven-dmlr
Loading

We will do following changes here

  • Introduce ServerRuntimeData as Json object which will initially hold serverVersion inside, but can be extended for future needs.
  • Change url from /api/admin/info/version to /api/admin/info/server
  • Rename usecase @UseCaseAdminChecksServerVersion to @UseCaseAdminFetchesServerRuntimeData
  • Update the URL builder (TestAPI)
  • Update the parse mechanism inside sechub-api.sh / admin-api.sh

@de-jcup de-jcup self-assigned this Feb 28, 2024
@de-jcup de-jcup changed the title API admin checks server version uses plain text instead of JSON Replace usecase "Admin checks server version" with "Admin fetches server runtime data" and provide JSON object Feb 28, 2024
@de-jcup
Copy link
Member

de-jcup commented Feb 28, 2024 •
edited
Loading

I marked this issue with a "breaking-change" label (because the REST API changed a bit) . But it is only a real breaking change, if somebody has automated administrative parts by their own. We provide and maintain admin-api.sh and DAUI which should be used, so it is not really a breaking change...

de-jcup added a commit that referenced this issue Feb 28, 2024
@de-jcup
Usecase changed: UC-40 renamed + changed java implementation #469
57a22f6 
-  Introduce ServerRuntimeData as Json object which will initially hold
serverVersion inside, but can be extended for future needs.
- Changed url from /api/admin/info/version to /api/admin/info/server
- Renamed usecase @UseCaseAdminChecksServerVersion to
  @UseCaseAdminFetchesServerRuntimeData
- Updated the URL builders (TestAPI)
- generated and commited new reduced open api file
- changed default sechub client implemenatation
sven-dmlr added a commit that referenced this issue Feb 29, 2024
@sven-dmlr
adapted to new api call /api/admin/info/server #469
91bc352 
- keep server_version behavior (string only)
- new action 'server_info' added
@sven-dmlr sven-dmlr added this to the Server 1.7.0 milestone Mar 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@de-jcup de-jcup

@sven-dmlr sven-dmlr

Labels
administration api breaking-change enhancement New feature or request
Projects
None yet
Milestone
Server 1.7.0
3 participants
@Jeeppler @de-jcup @sven-dmlr