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

In F!F example, REST endpoint Mundo does not appear in OpenAPI spec #6076

Closed
mhdirkse opened this issue Jan 8, 2024 · 9 comments
Closed

In F!F example, REST endpoint Mundo does not appear in OpenAPI spec #6076

mhdirkse opened this issue Jan 8, 2024 · 9 comments
Milestone
8.1.0

Comments

@mhdirkse
Copy link
Contributor

mhdirkse commented Jan 8, 2024

❗ please do not add sensitive information in issues, you can provide extra information via email using issue number as reference ❗

Describe the issue
In the F!F sources, there is a configuration in file example/src/main/resources/ConfigurationManualExerciseMundo. It has <ApiListener name="ManualExerciseMundo" uriPattern="/mundo" method="POST" />. However, url https://frank2example.frankframework.org/iaf/api shows a page in which the word "mundo" does not appear.

Reporter
Martijn Dirkse

To Reproduce
Steps to reproduce the behavior:

  1. Go to '...'
  2. Click on '....'
  3. Scroll down to '....'
  4. See error

Screenshots
If applicable, add screenshots to help explain your problem.

Configuration

Please provide the configuration of the Pipe or Receiver with the problem.

Input

Please provide an example of the input message. 
Alternatively, provide a Ladybug report.

Environment

FF! 8.1.0-20231223.223430: Frank2Example
Running on frank2example using Apache Tomcat/9.0.83
Java Version: OpenJDK Runtime Environment (11.0.21+9)
Heap size: 158M, total JVM memory: 317M
Free disk space: 246GB, total disk space: 501GB
Up since: 2023-12-23 23:43:04 (15d)

Additional Environment

  • DBMS: [e.g. Oracle, MSSQL, MariaDB, MySql, PostgreSQL]
  • Browser: [e.g. Chrome, Safari, Edge, Firefox]

Additional Context
Add any other context about the problem here. (f.e. ladybug report / test adapter with larva test)
@Laurens-makel
Copy link
Contributor

Hoi Martijn,

De link die je deelt refereert naar een endpoint dat een overzicht retourneert van alle beschikbare endpoints van de F!F API.

De OpenAPI spec die je zoekt vind je hier: https://frank2example.frankframework.org/iaf/api/webservices/openapi.json

Mundo lijkt hier in voor te komen.
image

@jacodg
Copy link
Contributor

jacodg commented Jan 8, 2024

I would expect the service url in https://frank2example.frankframework.org/iaf/api/webservices/openapi.json?uri=/mundo (which you can find going to webservices and opening the OpenAPI 3.0 for this service)

@jacodg jacodg added this to the 8.1 milestone Jan 8, 2024
@mhdirkse
Copy link
Contributor Author

mhdirkse commented Jan 9, 2024

Hallo Laurens. Wat bedoel je met de F!F API? Wie beslist welke adapters in het F!F bij de "F!F API" horen en welke adapters die er ook zijn daar buiten vallen? Is er ergens een file waar dat verschil bepaald wordt?

@Laurens-makel
Copy link
Contributor

Hallo Laurens. Wat bedoel je met de F!F API? Wie beslist welke adapters in het F!F bij de "F!F API" horen en welke adapters die er ook zijn daar buiten vallen? Is er ergens een file waar dat verschil bepaald wordt?

Ik doel op de API van het framework zelf, deze wordt gebruikt voor de GUI.

De adapters met een ApiListener die de Frank developer bouwt met het framework worden op /api ontsloten en niet op /iaf/api .

@mhdirkse
Copy link
Contributor Author

mhdirkse commented Jan 9, 2024

Als je https://frank2example.frankframework.org/iaf/api/webservices/openapi.json?uri=/mundo opent, dan zie je een OpenAPI spec waarin Mundo beschreven staat.

@mhdirkse
Copy link
Contributor Author

mhdirkse commented Jan 9, 2024

Jaco en ik vinden het vreemd dat er in de status pagina van de console een "*" in het URI pattern staat, zie figuur.
image

Deze figuur krijg je door in de status pagina van de console de adapter ManualExerciseMundo open te klappen.

@nielsm5
Copy link
Member

nielsm5 commented Feb 19, 2024 •
edited
Loading

Jaco en ik vinden het vreemd dat er in de status pagina van de console een "*" in het URI pattern staat, zie figuur. image

Deze figuur krijg je door in de status pagina van de console de adapter ManualExerciseMundo open te klappen.

Dat is inderdaad raar, ik maak daar een los issue voor. Is dit issue zo verder afgehandeld?

@nielsm5 nielsm5 moved this to On Hold in Frank!Framework Feb 19, 2024
@mhdirkse
Copy link
Contributor Author

Ja, is zo afgehandeld, @nielsm5.

@github-project-automation github-project-automation bot moved this from On Hold to Done in Frank!Framework Feb 20, 2024
@jacodg
Copy link
Contributor

jacodg commented Feb 27, 2024

Volgens mij is het ook nog steeds een p;robleem dat "servers" leeg is in https://frank2example.frankframework.org/iaf/api/webservices/openapi.json?uri=/mundo (zie mijn comment van 8 jan). Ik heb nu #6373 aangemaakt

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
Frank!Framework
Archived in project
Milestone
8.1.0
Development

No branches or pull requests
4 participants
@jacodg @nielsm5 @mhdirkse @Laurens-makel