Skip to content

Provide detailed reference documentation for the new endpoint infrastructure #10001

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.

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

Closed
wilkinsona opened this issue Aug 11, 2017 · 8 comments
Closed
Assignees
Labels
type: documentation A documentation update
Milestone

Comments

@wilkinsona
Copy link
Member

wilkinsona commented Aug 11, 2017

Some things to document:

  • @Endpoint
  • @JmxEndpointExtension
  • @ReadOperation
  • @Selector
  • @WebEndpointExtension
  • WebEndpointResponse
  • @WriteOperation
  • Type conversion
  • Web request predicates (GET for read, POST for write, produces, consumes, etc)
  • Default response status for web operations (200, 404 for null with GET, 204 for null with POST, etc)
  • Support for HTTP range requests to operations that return a Resource (WebFlux and Spring MVC only)
  • -parameters is required to infer parameter names
  • @Nullable for optional parameters
@shabino
Copy link

shabino commented Nov 14, 2017

Please consider documenting endpoints.<endpoint name>.cache.time-to-live and that the value is expressed in millis.

@shabino
Copy link

shabino commented Nov 14, 2017

See #11010 for a suggestion regarding @Selector parameter naming.

@snicoll
Copy link
Member

snicoll commented Nov 14, 2017

Please consider documenting endpoints..cache.time-to-live and that the value is expressed in millis.

It is already documented. Also, your IDE should tell you that when you use that key in application.properties/yml

@philwebb
Copy link
Member

We should add a small section in the reference docs to explain what the cache is for and how to configure it.

@snicoll
Copy link
Member

snicoll commented Nov 23, 2017

There's a bunch of stuff already done as part of #10176. I'll review what's missing still.

@snicoll
Copy link
Member

snicoll commented Nov 24, 2017

Also, let's make sure we document the dependency to -parameters (see #11010 (comment))

@manderson23
Copy link

In the documentation regarding unauthenticated access to actuator with the sample code you provide would it be useful to mention that csrf being enabled by default results in calls to POST end points being forbidden? This caught be out on upgrade from 1.5.x.

@snicoll
Copy link
Member

snicoll commented Feb 8, 2018

@manderson23 see #11758 (this issue isn't supposed to touch that area anyway).

@wilkinsona wilkinsona modified the milestones: 2.0.0.RC2, 2.0.0 Feb 20, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation A documentation update
Projects
None yet
Development

No branches or pull requests

5 participants