Skip to content
This repository has been archived by the owner on Dec 13, 2022. It is now read-only.

doc(api): document how to generate html api documentation #8394

Merged
merged 1 commit into from
Mar 5, 2020

Conversation

kduret
Copy link
Contributor

@kduret kduret commented Mar 5, 2020

Description

  • document how to generate html of openapi documentation
  • add generated documentation to gitignore

Fixes MON-4652

Type of change

  • Patch fixing an issue (non-breaking change)
  • New functionality (non-breaking change)
  • Breaking change (patch or feature) that might cause side effects breaking part of the Software
  • Updating documentation (missing information, typo...)

Target serie

  • 2.8.x
  • 18.10.x
  • 19.04.x
  • 19.10.x
  • 20.04.x (master)

@kduret kduret requested review from cgagnaire and ganoze March 5, 2020 10:42
@victorvassilev victorvassilev self-requested a review March 5, 2020 10:45
@kduret kduret merged commit b143520 into master Mar 5, 2020
@kduret kduret deleted the MON-4652-remove-api-html-file branch March 5, 2020 11:47
victorvassilev added a commit that referenced this pull request Mar 6, 2020
* Adapt font regexp path for Windows (#8375)

* enh(apiv2): add event listing for hosts and services
Resolves: MON-4866, MON-4867

* enh(apiv2): add event listing for hosts and services
Resolves: MON-4866, MON-4867

* fix(doc): regenerate html for doc

* feat(ui): Implement Resources listing (#8371)

* fix(tests): update error message on unit test

* Fix the search parameter 'IN' (#8380)

* fix(doc): fix scrollbar issue in API documentation (#8378)

* feat(build): stash git sources for Sonar analysis.

* feat(ui): Implement Unified view search (#8382)

* feat(build): fail build on front-end style errors.

* enh(doc): update docblock in interface

* fix: fix ESLint warnings

* doc(api): document how to use search parameter with API (#8376)

* fix(test): improve unit test SqlRequestParametersTranslatorTest::testTranslateSortParameterToSql

* fix(configuration): export hosts geo_coords to remote server (#8390)

* fix(ldap): use define user member_attribute var (#8287)

* fix(ldap): use define user member_attribute var

* fix(code): use PSR2

* feat(ui): Implement Unified view downtime and acknowledge tooltips (#8385)

* fix(code): Clean switch case service monitoring (#8285)

* fix(code): dedicated meta event console does not exist anymore

* fix(code): scheduling queue console does not exist anymore

* fix(code): merge some cases

Co-authored-by: Colin Gagnaire <cgagnaire@centreon.com>

* fix(remote-server): fix import with strict mode (#7944)

Refs: MON-7944

* doc(api): document how to generate html api documentation (#8394)

* feat(doc): update the API documentation (#8393)

* feat(doc): update the API documentation

Resolve MON-4887

* fix(doc): apply feedback from PR

Resolve MON-4887

* fix(doc): remove again api html documentation

* Update src/Centreon/Domain/Monitoring/Entity/DowntimeEventObject.php

Co-Authored-By: Kevin Duret <kduret@centreon.com>

* Update src/Centreon/Domain/Monitoring/Interfaces/TimelineRepositoryInterface.php

Co-Authored-By: Kevin Duret <kduret@centreon.com>

* Update src/Centreon/Domain/Monitoring/Interfaces/EventObjectInterface.php

Co-Authored-By: Kevin Duret <kduret@centreon.com>

* Update package-lock

* enh(apiv2): add event listing for hosts and services
Resolves: MON-4866, MON-4867

* fix(doc): regenerate html for doc

* fix(tests): update error message on unit test

* enh(doc): update docblock in interface

* Update src/Centreon/Domain/Monitoring/Entity/DowntimeEventObject.php

Co-Authored-By: Kevin Duret <kduret@centreon.com>

* Update src/Centreon/Domain/Monitoring/Interfaces/TimelineRepositoryInterface.php

Co-Authored-By: Kevin Duret <kduret@centreon.com>

* Update src/Centreon/Domain/Monitoring/Interfaces/EventObjectInterface.php

Co-Authored-By: Kevin Duret <kduret@centreon.com>

* resolve conflict with html doc

Co-authored-by: Tom Darneix <tomdar87@outlook.com>
Co-authored-by: Bruno d'Auria <bdauria@centreon.com>
Co-authored-by: Laurent Calvet <lcalvet@centreon.com>
Co-authored-by: Kevin Duret <kduret@centreon.com>
Co-authored-by: Matthieu Kermagoret <mkermagoret@centreon.com>
Co-authored-by: Valentin Hristov <vhr@users.noreply.github.com>
Co-authored-by: Colin Gagnaire <cgagnaire@centreon.com>
victorvassilev added a commit that referenced this pull request Mar 9, 2020
* enh(apiv2): add extra fields to host read endpoint
Resolves: MON-4943

* fix(code): Clean switch case service monitoring (#8285)

* fix(code): dedicated meta event console does not exist anymore

* fix(code): scheduling queue console does not exist anymore

* fix(code): merge some cases

Co-authored-by: Colin Gagnaire <cgagnaire@centreon.com>

* fix(remote-server): fix import with strict mode (#7944)

Refs: MON-7944

* Update src/Centreon/Domain/Monitoring/Host.php

Co-Authored-By: Kevin Duret <kduret@centreon.com>

* Update src/Centreon/Domain/Monitoring/Host.php

Co-Authored-By: Kevin Duret <kduret@centreon.com>

* doc(api): document how to generate html api documentation (#8394)

* fix(topcounter): use session cache to store top counter hosts/services results (#8189)

* use session cache to store top counter hosts/services results

* resolve comments review

* enh(performance): session size fix

* fix(topcounter): manage reviews

* fix topcounters session errors

* fix timezone

* replace deprecated method

* remove useless request to get configuration poller main.cfg

* Update moveFiles.php

* Update moveFiles.php

Co-authored-by: qgarnier <garnier.quentin@gmail.com>
Co-authored-by: sc979 <34628915+sc979@users.noreply.github.com>
Co-authored-by: Kevin Duret <duret.kevin@gmail.com>

* enh(config): prepare anomalydetection module (#8321)

* enh(config): prepare anomalydetection module

* Update service.class.php

* fix(config): remove dead code

Co-authored-by: qgarnier <garnier.quentin@gmail.com>

* enh(apiv2): add extra fields to host read endpoint
Resolves: MON-4943

* Update src/Centreon/Domain/Monitoring/Host.php

Co-Authored-By: Kevin Duret <kduret@centreon.com>

* Update src/Centreon/Domain/Monitoring/Host.php

Co-Authored-By: Kevin Duret <kduret@centreon.com>

* remove api html doc

Co-authored-by: Colin Gagnaire <cgagnaire@centreon.com>
Co-authored-by: Kevin Duret <kduret@centreon.com>
Co-authored-by: qgarnier <garnier.quentin@gmail.com>
Co-authored-by: sc979 <34628915+sc979@users.noreply.github.com>
Co-authored-by: Kevin Duret <duret.kevin@gmail.com>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants