Investigate how to build other REST API generated docs

Aperta
  • Qualcosa non va?
#3,428 2 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
25/100
Tipo di issue
Documentazione
Chiarezza
Da chiarire
Stato di attività
Ferma
Stack tecnologico
openapi
Ambito
documentation

Direzione di ricerca

Inizia esaminando la documentazione dell’OpenAPI REST API nella pagina KC collegata e l’epic autogen (#2615) per determinare come vengono attualmente create le Batch REST APIs e le JMX REST Connector REST APIs. Discuti i risultati con Michal e Alasdair; il lavoro è completato quando l’approccio di creazione è documentato e viene creata una issue di follow-up con priorità per integrare questa documentazione nella documentazione di Open Liberty.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

As well as the Liberty API/SPI docs that we've discussed previously (and mentioned in the autogen epic), there are some OpenAPI REST API docs in the KC that Alasdair has previously said do need to come over the OL docs. These are API docs generated by OpenAPI for APIs that are provided to use with Liberty (Batch REST APIs, and JMX REST Connector REST APIs) (so, to be clear, this has nothing to do with the OL support for MicroProfile OpenAPI etc).

Alasdair's comment when we first audited the KC, was that we need to start by finding out how the KC is currently building these docs. Then, talk to Michal about how we get these docs built into the OL docs, and will probably need an issue creating then like we have for the API/SPI docs. That issue should probably be added to the autogen epic and prioritised with Alasdair against the other issues listed there.

Lingua principale
Nessun dato sulla lingua
Stelle
14
Fork
58
Merge medio
1h
PR unite (30g)
25

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di OpenLiberty/docs

Tutte le issue di OpenLiberty/docs

Issue simili

Altre issue su Documentation

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.