Document one REST endpoint with springdoc #82

[palagdan]

Resolves #82
if you like this style of documentation, I can document the other endpoints in the current ticket.

[palagdan]

@blcham

I'm currently blocked by this ticket. I've spent a lot of time trying to figure out why I can't access the generated Springdoc when using internal authorization via an Nginx deployment.

When I make a direct request to the backend running locally, I receive the correct API documentation. As you can see from the screenshots, the URLs are identical, and Nginx should be proxying the same path.

Nginx deployment (Springdoc not generated):

Local backend (API doc available):

Also I am not sure about this annotation:

@Operation(security = {@SecurityRequirement(name = "bearer-key")

If we are using internal authorization, accessing the Springdoc should only require a session ID to pass the security filter. Bearer tokens are only necessary when OAuth is in use.

[blcham]

@kostobog see my comments

[blcham]

Suggested change

	Invalid Invalid failureMode, e.g.
	Invalid failure mode, e.g.

[blcham]

Suggested change

	- The uri should be null or unique
	- Duplicate entity name
	- Name must not be empty
	- failure mode uri is not null nor unique.
	- failure mode name already exists.
	- failure mode name is empty.

[blcham]

I tried to make it more consistent as it seemed to me that some of the bulets have semantics of errors (Duplicate entity name) and other ones semantics of constraints (The uri should be null or unique)

[kostobog]

@blcham
Ok but there are two issues:

• I will have to update the actual messages in the exceptions/validation-errors.
• these messages are generic - I will have to find a way to add the entity type, e.g. failure mode) to the message.

See commit d954733

[palagdan]

@blcham

I described in the README.md how to access Swagger. It works when you make requests directly to the backend only for authorized users.