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.

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

[DOC] better documentation for /_render/template API #6046

Closed
1 of 4 tasks
rursprung opened this issue Jan 5, 2024 · 1 comment · Fixed by #7219
Closed
1 of 4 tasks

[DOC] better documentation for /_render/template API #6046

rursprung opened this issue Jan 5, 2024 · 1 comment · Fixed by #7219
Assignees
Labels
2 - In progress Issue/PR: The issue or PR is in progress. API

Comments

@rursprung
Copy link
Contributor

What do you want to do?

  • Request a change to existing documentation
  • Add new documentation
  • Report a technical problem with the documentation
  • Other

Tell us about your request.
the /_render/template API is barely documented, it is only mentioned in passing and not even in a chapter on its own:

```json
GET /_render/template
POST /_render/template
GET /_render/template/<id>
POST /_render/template/<id>
```

this should at the very least be a dedicated chapter within that page if not a page on its own (i don't know if you plan on having one page per API - which might be nice - or have them grouped together; if you create a dedicated page it should be linked on the current page so that it can be found easily).

i also noticed that a lot of the API documentation doesn't have the "stable since" information (cf #106) anymore, including this API.

What other resources are available?
as usual, ES has a nice page on it :)

@hdhalter
Copy link
Contributor

hdhalter commented Jan 8, 2024

Thanks for submitting this issue, @rursprung ! We are turning our focus to missing APIs soon, so we can address this then. In the meantime, if you want to take a stab at documenting it, please do : ).

I read through the discussion on 'stable since' and it sounded like the consensus was to not use that terminology and instead only document anything breaking?

@hdhalter hdhalter added API 1 - Backlog - DOC Doc writer assigned to issue responsible for creating PR. and removed untriaged labels Jan 8, 2024
@Naarcha-AWS Naarcha-AWS self-assigned this Apr 17, 2024
@Naarcha-AWS Naarcha-AWS added 2 - In progress Issue/PR: The issue or PR is in progress. and removed 1 - Backlog - DOC Doc writer assigned to issue responsible for creating PR. labels Apr 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
2 - In progress Issue/PR: The issue or PR is in progress. API
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants